2019年11月16日C言語仕様の書き込み仕様2.コメント

1.ノートの有効量は、少なくとも20%が正確で理解できる言語の簡潔なコメントでなければなりません
2.ヘッダファイルが記載されている必要がありコメントは、次のようになります。リリースノート、バージョン番号、作成日、作成者、コンテンツ、機能、ログを変更します。
ヘッドの機能が表示されなければならない3.注:オブジェクト/関数、入力パラメータ、関数の出力パラメータ、戻り値、呼び出し関係(関数テーブル)などが挙げられます。
4.書き込みコード注釈エッジ、コードの変更、コメント、コードの整合性を確保するために、注釈を、対応する修正します。コメントは無用削除しました
曖昧でない、正確かつ明確にする5. Notesコンテンツ
6. Doがないあなたが略語を見て方法を知っているコメントだけを使用します
ステートメントが上に置かれたときに空白行に間隔を置いて配置されるコードまたは右の単一ライン上に配置されるコードの7注単一ライン、
8.変数は、定数は、マクロは、コメントを上または右に配置する必要があります
9.なお、右のメンバーに配置されたコメント、の上にデータ構造
10.グローバル変数がその機能など、値の範囲、関数呼び出しを含む詳細なメモを、持っている(とにかく、私はずっととして自分自身にラベルを付けていません)
11. DOは、コードまたは式にコメントを挿入しません
12.ノート形式のコードのコメントそれ、ない混乱は、コードの認識に影響を与えます。注インデントと記載されているように、好ましくは、同じ符号は、植字プログラムニート、簡単に理解することを可能にします。統一フォーマット:/ * ...... ...... * /
13.ノート有用な情報ではなく、情報無用のコメント
14. A変数定義文と分岐(条件付き分岐、ループ、等)は注釈を書き込む必要があります
15.switch case文についての最もよいのコメント
16.あなたは非常に英語の非常に明確な表現でない限り、中国の言語が、推奨されます
 
 
   ------リファレンス「C言語ルーチン素晴らしい200例。」

おすすめ

転載: www.cnblogs.com/epll/p/11874141.html