c-lang:モジュールヘッダ

プログラムの先頭には、以下のようなコメントをつけると役立つ。 プロの世界では、ほぼ常識になっている。

プログラム名（ファイル名）

プログラムの目的

作成者

作成年月日

以下のような情報も役立つ

参考文献

ファイルのフォーマット

制約事項

改版履歴

エラー処理

注記

リファレンス情報、参照先

上位モジュール

下位モジュール

また、各関数の先頭には、

関数の動作

各引数の説明

戻り値についての説明

使用するグローバル変数

制限事項

注意事項

コメントを書く上で重要な事は、

不要なコメントは 書かないこと

である。