すべてのプログラマーが従うべき優れたプログラミング スタイル

アマチュアプログラマーであろうとプロプログラマーであろうと、正しいプログラミングスタイルはソフトウェア製品の機能を向上させるだけでなく、ソフトウェア災害の発生を大幅に減らすのに役立ちます。今日は、より良いプログラミング スタイルを実現するのに役立ついくつかの最良のルールを見ていきます。

コードの読みやすさは最も重要です

コードを読みやすく理解できるようにするには、一貫した方法でフォーマットする必要があります。関数と変数の名前は意味のあるものでなければならず、コメントの表現は簡潔かつ正確である必要があります。また、コードの扱いにくい部分をすべて正確に文書化することも重要です。ソフトウェア プログラムがなぜ動作するのか、また、あらゆる状況下でスムーズに動作するのかを理解する必要があります。

正しい命名規則に従うことが必須です

クラス、関数、変数に名前を付ける場合は、次のガイドラインに従う必要があります:

特定のクラス名の最初の文字は必ず大文字にしてください

大文字と大文字を使用してください。複数の単語を区切るには小文字を使用します。

定数名は大文字にし、単語を区切るにはアンダースコアを使用します。

特定の関数名と変数名の最初の文字は必ず小文字にしてください。

略語を正しく使用するように注意してください。たとえば、maximum の代わりに max を使用します。

必要に応じてスペースを使用します

スペースはコンパイラにとっては意味がありませんが、コードの読みやすさを向上させるために使用できます。たとえば、関数の間に 3 行の空白行を残すことができます。関数内で個別の空白行を使用して、コードの重要なセクションを区切ることもできます。

コードに一定の保守性があることを確認します

機能の調整やバグの修正のために別のプログラマーが置き換える場合、書かれたコードが明確で理解しやすいことを保証する必要があります。必要に応じていつでもこれらの定数値を変更できるように、関数内のキー値は定数でマークする必要があります。全体として、コードは堅牢であり、あらゆる種類の入力を処理でき、クラッシュすることなく期待される結果を提供できる必要があります。

コメントは理解しやすくなければなりません

コメントは有意義で、ソフトウェア プログラムに関するすべてを明確に説明するものである必要があります。コメントの数は重要ではなく、質が重要です。コメントは /*comment*/ スタイルを使用して記述し、コメントが各ソース ファイルの先頭にあることを確認する必要があります。さらに、コメントに自分の名前、コードが書かれた日付、プログラムが実際に行うことの簡潔な説明を含めることもできます。ただし、明らかな機能を持つ一部のコメントを省略することもできます。従う必要があるインライン コメント形式は //comment です。

関数を正しく使用する

各関数に含まれるコード スニペットは短く、特定のタスクを完了できる必要があります。関数を「ブラック ボックス」と考えてください。独立していながら、あらゆる種類の入力を効率的に処理できます。このような経験則、いわゆる「10 行ルール」を忘れないでください。つまり、関数が一般的に 10 行を超える場合は、最も洗練された方法で簡略化する必要があります。また、反復的なコード スニペットは別の関数として設定する必要があります。上記のアプローチにより、プログラムの長さが短縮されるだけでなく、可読性も大幅に向上します。

きれいなコードのインデント

インデントは、ソフトウェア プログラムのフロー制御において重要な役割を果たします。新しい while、for、if ステートメント、および switch 構造にはインデントされたコードが必要です。これは、行内のステートメントから括弧が省略されている場合にも使用できます。たとえば、if ステートメントがある場合、対応する else ステートメントをまとめてインデントする必要があります。

結論

これらの正しいプログラミング スタイルに慣れていれば、ソフトウェア プログラムの作成は非常に興味深い活動になるでしょう。最後に、この記事があなたのお役に立てれば幸いです。異なる意見がある場合は、ぜひ一緒に議論してください。 M LAMPブラザーズオリジナルPHPチュートリアルCD/「Speaking PHP」上質版も無料プレゼント、詳細相談 公式サイトカスタマーサービス：http://www.lampbrother.net