プログラマーは、ソース上に書くコメントにも注意したほうがよい

コメントおもしろい()

>// ここは難しいのでとりあえず放置
>// なぜやってるのか不明
>// いろんなエラーが出るけど些細な問題なので無視する

JavaScriptなんて読まれるんだから恥ずかしいコメント書いちゃだめ。
はてなブログが遅いのはだいたいJavaScriptのせい - もふぬこ戦記

何か問題があった時に、ソース自体を読む(レビューする)ことがあるのですが、そういう時に、不安にさせる、特にコードをあまり読めない人が不安になるようなコメントを残さないほうが良いでしょうと思います。

まあ、ケースバイケースで、あえてコメントを残すことで、自身の正当性?を示せて、とばっちりの泥をかぶらなくてもよい場合もあります。でも、そのプロジェクトの他の人?は、そういうわけにはいかないとおもうけど、そこが微妙なんですけどね。

自身を守るという側面はあるけど、顧客が不安になるようなコメントをプログラム(ソース)内?に残すのは、やめたほうが良いかもって話です。

ソースをちゃんと読めばわかる話なんだけど、そもそも誤解を招くようなコメントを書かなければよいという話も逆にあるわけです。

人間、外見が大事なように、不安にさせるようなコメントが混ざってると、それだけで色眼鏡で見られてしまうんですね。でも、ビジネスなんで、偏見です、誤解ですとか言っても、どれだけ意味があるかなんですね。


//なんとなくおかしい
//間違っているように見えるが、正常動作している
//なぜか、動かない
//本来はこういう仕様が正しいと思うが、仕様書どおりに作るとこうなる

ソースコードで発見した奇妙なコメント集 | Webクリエイターボックス

プログラマー(エンジニア?)の間では、あまり気にならなかったりするのが不思議。

たとえば、コメントに遊びコメントが入っていても気にならない人もいるけど、
それをみて、真面目に仕事してますと非エンジニアに説明するのは、たぶんかなり無理があろうと思う。

「エンジニアというのはこういうものです。それぐらい自由にさせないと、いい仕事ができないんです。」とか言われても、問題が起こってないときなら、そういうものか?と思えても、障害が起こっている、何とかしないと火が噴く状態では、イラッとくると思うよ。

スポンサーリンク

コメントを残す

メールアドレスは公開されません。
また、コメント欄には、必ず日本語を含めてください(スパム対策)。