良く、プログラミング言語のコメントで意味がないと突っ込まれる物があります。
i=0; //iにゼロを代入する
みたいな物です。はっきり言って役に立たないコメントです。しかし、これってどこかで見たことが無いでしょうか？ それは「初学者のテキスト」です。
プログラミング言語自体を説明する書籍には当たり前ですが、その命令自身の意味が説明されています。
悪の原因は初学者の解説にコメントを使うこと
私はコメントが誤って使われる原因は、初学者の説明にコメントが使われることです。プログラミング以外でも人など動物って「最初に見たもの」が刷り込まれます。幼少期の時に見たものがその人の「常識」となるわけです。
それと同じように、初学者のテキストに書かれているコメントを最初に見てしまうからその書き方が常識になってしまうわけです。
- #include<stdio.h>
- int main(void)
- {
- int sum=0; //足し算する変数をリセットする
-
- for(int i=1;i<=10;i++){ //１から１０までループする
- sum+=i; //現在のカウンターを足し算する変数に加算する
- }
-
- printf("%d\n",sum); //結果を表示する
- ;
- return 0;
- }
これはよくある初学者向けテキストに書かれているコメントです。ただ、これを業務でやられると「ゴミコメント」になります。
初学者の学習ではコメントを封印する
上記コードからコメントを除去します
- #include<stdio.h>
- int main(void)
- {
- int sum=0;
-
- for(int i=1;i<=10;i++){
- sum+=i;
- }
-
- printf("%d\n",sum);
- ;
- return 0;
- }
そして、初学者の説明として言葉で説明します。
このコードは１から１０までをループさせて、その値をSUMという変数に代入します。
forは(変数の初期化；とどまる条件；ループ一回が終了した時の処理)
+= という演算子は足し込むという意味です。例えばsum+=5 とすると sumの値に５を加えるという意味です。
そして、printfでその結果を出力します。
この様な形でコードを説明します。非常にコメントとしてインラインで書きたくなりますが、初学者への変な刷り込み防止という意味で止めて下さい。
本当のコメント術を教える
そして最後に、本当のコメント術を教えて下さい。
- #include<stdio.h>
- //１から１０までの数を足して表示する。
- int main(void)
- {
- int sum=0;
-
- for(int i=1;i<=10;i++){
- sum+=i;
- }
-
- printf("%d\n",sum);
- ;
- return 0;
- }
業務ならこの程度のコメントで十分です。やっていることは１から１０までの数を足して表示する物です。このプログラムを実行すれば１から１０の合計が表示されるわけであり、特にプログラミングテクニックとしての特記事項はありません。
初学者の学習テキストとしてのコメントを封印するのは苦しいかもしれませんが、初学者である期間は短いです。その後は業務としてのコメントを求められるので、初学者の間違ったコメントを封印することは非常に重要であると考えます。
Amazonでコーディング術
