Learnで、プログラミングを教えるソフトウェア開発者・フリーランスライターこの記事は、2019年11月に公開された記事の翻訳転載です。著者の許可を得て配信しています。Programming一般的に初心者が無視するより良いプログラミングのための簡単なルール「スタイルの目的は、コードを自分や他の人が読みやすくすることであり、優れたスタイルは優れたプログラミングに不可欠である。ブライアン・W・ケニンハン「プログラミングの実践」プログラミングを独学で習得する場合、誰もその仕事をチェックしていないので、容易に悪い習慣やスタイルが身に付くことになります。これらの問題に直接取り組む書籍や研修コースは多くないことから、クリーンなコードの基準に関する参照資料はあまり多くは存在しません。この記事では、クリーンで美しいコードを書くことに関する実用的なアドバイスを提供しようとするものです。変数の名前を選択する際は、その名前に何らかの意味を込めること「説明的な名前にすべきか、それとも適当なもので片づけるか?」これは、新しい変数を作成する際に直面する難問です。ここでは、下記ライアンWカーニガンのアドバイス(上記の書籍)はここで実際に役に立つと思われます。・グローバル関数、クラス、および構造体には、プログラムでの役割を示すわかりやすい名前を付ける必要があります。・対照的に、ローカル変数には短い名前で十分です。するのはやり過ぎです。・従来の方法で使用されるローカル変数の名前は、極めて短くすることができます。使用する頻度が非常に高く、これらに長い名前を付けてもメリットはほとんどなく、おそらくはロスになります。ブライアンがこの本を書いた90年代よりもずっと良くなっています-それは変数をオートコンプリートにするIDEに似ています。好きな言語で書かれた関数の構文を理解するのは簡単です。コードを関数に分割するタイミングを学ぶには、練習とある種のデザイン感覚が必要です。1つの目標として、プログラムを新しいケースに拡張する際は、関数が再利用できるように設計することです。そのほかに何かありますか?このようなデザインの選択工程は、プログラミングの楽しさでもあります。Code」では、選択肢として下記3つのヒューリスティックを挙げて説明がなされています。・関数は小さくする必要があります。どれほどに小さく?スクリーンに収まる程度内または20行以下。・関数にはわかりやすい名前を付けます。関数は小さければ小さいほど、またその焦点が狭ければ狭いほど、わかりやすい名前を選択しやすくなります。名前を長くすることを恐れてはいけません。長いわかりやすい名前は、短い謎の名前よりも優れています。長いわかりやすい名前は、長いわかりやすいコメントよりも優れています。関数が意図するところは、その名前によって明確にする必要があります。最初の関数を書く場合、それはおそらく長く複雑で、上記のルールのいずれにも沿わないものになるでしょう。後でコードを調整して再フォーマットできます。上記すべてのルールに沿った関数を最初から書けるような人はいなと思います。あなたが目指して努力すべきは目標は関数の構築であることを覚えておいてください。目標を見失ってはさせてはいけません。コードを文書化し、役立つコメントを書くコードには常に、関数とモジュールドキュメントとして機能するコメントを含める必要があります。すべての関数定義は、下記のようなコメントを使って処理する必要があります。関数の動作を記述する1~2語句の短文。