その4 意味のあるコメントを書く、意味の無いコメントは書かない。 <プログラミング再入門>

読んだときに、理解の助けになる目的で書くのがコメント。
修正履歴を残すときの規約とかは置いておいて、
 
機械的にコメント書いてるだけなら、やめろよ。
意味ないから。
って、コメントを見かける機会は多かった。

// XXの判定
int i = func(a);
if (0 < x){
…..
}

class ObjA{
 
 //コンストラクタ
 public ObjA(){
 …..
 }
}

みたいなコメント。自動的についてくるなら仕方ないけど、
わざわざ書くなよ。見りゃ分かるよ。誰でも。
 
で、そういうコメント書くのに限って、
なぜ、その判断なのか、意味に戸惑うような場面では何も書かない。
義務で書いてる感がありありと伝わってくる。
 
じゃあ、書くなよコメント。
実害は何もないんですけど、、、

何故コメント書くのか、意味考えずに書いてる。
 
その無神経さは、イヤですね。危険ですし。
奴隷への入り口だとも思う。
機械的に、意味考えず作業し出したら、
あっという間に転落するシゴトだから。怖いシゴトです。
 

  
 
質問コーナー、お問い合わせは、sanpome.net@gmail.com まで。

  
 

社会・経済ニュース ブログランキングへ

にほんブログ村 海外生活ブログへ
にほんブログ村

カテゴリー: 2017, プログラミング タグ: パーマリンク

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です


*