PHPコードのコメント

の前に書かれた

コメントは、コード内の説明や指示として理解できます。コメントを使用すると、プログラムの可読性が向上するだけでなく、コメントの内容はプログラムによって実行されません。

個人プロジェクト

個人 Web サイト: LN Movie Network 個人ブログ: L&N ブログ

PHP コメント

PHP コメントには 3 つのスタイルがあります

1. C++ スタイルの単一行コメント (//)

// 这是一条注释信息：打印 hello worldecho 'hello world';

2. C++ スタイルの複数行コメント (/**/)

 /* 这是一个多行注释       echo '你好';       echo ‘这个世界’;    */echo "你好这个世界";

3. シェル形式のコメント (#) を使用します。

単一行のコメントと同様、# を含む行は実行されません

echo '你好这个世界'; # shell 风格注释，这里的内容不会被执行

有効なコメントPHP の場合

プログラム コメントは、標準化されたプログラムを作成する際の重要な部分です。コメントは主にコードの説明と説明を目的としており、主な機能はスクリプトの目的、著作権表示、バージョン番号、作成日、作成者、内容などの説明です。プログラムを読んで理解するのに役立ちます

コメントの原則

言語

• コメントの言語は正確で、理解しやすく、簡潔でなければなりません

注: 間違ったコメントは役に立たないだけでなく有害です

• コメントはコードのコンパイル時に無視され、最終コードにはコンパイルされませんコンパイラ ファイルによって実行可能であるため、コメントによって実行可能ファイルのサイズが増加することはありません。

• コメントはコード内のどこにでも記述できますが、通常はコードの先頭または末尾に記述されます

注:コード行または式の途中にコメントを挿入することは避けてください。そうしないと、誤解が生じやすくなります。

• プログラムコードを変更する場合は、コードとコメントの同期を確保するために、必ず関連するコメントも同時に変更してください。

• 実際のコード仕様では、コメントコードはプログラムコードの20%程度、つまり100行のコードに20行のコメントが必要です

注: 不要なコメントを避ける

• 特定のプログラムであることを示すコメントをプログラム ブロックの終了行の右側に追加します。

• コメント内での使用は避けてください。 略語、特に一般的に使用される略語

• 記述されている内容と同じ略語を含む注釈は、プログラムのレイアウトが整然としており、コメントの読み取りと理解が容易になります

概要

厳密で態度の高いプログラマになりたい場合、これらの一見取るに足らない原則は、実際には責任あるプログラマを表しています。私たちが書くプログラムに対する態度。