ステップス

1. 1 追加するコメントの種類を決定する。プログラマーは、コメントに対していくつかの異なる主な目的を持ち、これらの目的によって、コメントに含まれる正確なフォーマットとスタイルが決定されます。コードモジュールのコメントを検討する。モジュールコメントは、より高度なコメントで、通常、コードモジュールの一般的な目的、および著作権や作者などの他の情報を記述します。プログラムコメントの必要性を評価する。また、各種機能コードの手順も注釈を入れる必要があります。プロセスコメントは、コードの特定の機能に関連し、プログラムの書き方に基づいて、他のプログラマにプログラムの正確な結果を警告するのに役立ちます。

2. 2 コードコメントの詳細な利用区分を選択します。プログラムコメントなど、ある種のコメントには、さまざまな形式があります。これらの使い分けを理解することで、正しいコメントをプログラムに追加することができます。プログラムにおける目的コメントの利用を評価する。これらは、プログラムが何を行うかを記述しています。関数の戻り値コメントの利用を検討する。これらは、他の人がプロシージャから返される値を理解するのに役立ちます。条件付きコメントを記載する。条件付きコメントは、起こりうるエラー条件やエラー処理、コードが正しく動作するために満たすべき条件などを記述することができます。

3. 3.コメントの形式を選択する。また、特定のコード行にコメントを付けるにはどうしたらよいかという問題もあります。左側のコメントを使ってください。これらのコメントは、画面の左側から始まり、一行分続きます。多くの場合、コーダーは画面の右側付近のどこかでコメントを終了し、新しい行に移動して、コメントを継続する必要があります。インラインコメントを使用する。インラインコメントは、コード片の直後にアポストロフィがあり、同じ行に配置されます。

4. 4 コメントの冒頭にアポストロフィを付ける。これは、実際にコメントをコードに書き込む際の重要なステップです。アポストロフィは、Visual Basicコンパイラがコメント用に認識する、特定のテキストプロトコルです。これがないと、コンピュータはコメントをコードとして読み取ろうとします。

• 空白を使う。多くのプログラマーは、コメント、コードモジュール、プロシージャなどを、エンターキーを押すことで区切り、コードドキュメント全体でスペースを使用することを選択します。マシンは空白を読み取らないことを認識することが重要です。コメントそのものと同様、これは単に人間の目から見たコードの見栄えを良くするための方法です。