菊池 Blog

移転しました 続・菊池 和彦の足跡

AILight Banner
AILight Blog

プロフィール

菊池 Blog

目次

Blog 利用状況

記事分類

過去の記事

タグ

何でもいいから全部書け

「いいから黙ってコメント書け」という話 - miauの避難所

9割賛成

自分は何でもいいから全部書け、コードで表現できてるならそれでよし、コードで表現できてないならコメントでもなんでもいいから書け

コードで十分表現できている事に無駄にコメントで説明をする「必要はない」。

うだうだとコメントで繰り返し説明されるのは「うっとおしい」、コードとコメント両方読むのは「面倒臭い」ので必要以上にコメントをするのはアレだけど、嘘コメントとか実害がなければコメントするのは基本は良い事と思ってます。

あえて言うと「コメントは定型化するな」、

// 初期化
初期化してる
// 処理
try {
    処理してる
}
finally {
    // 後始末
    後始末してる
}

こんなコメントには意味はない。しかし、「決まりだから」で書くとか、お約束なので「頭を使わずに書けるから書いときました」なコメントは無い方がマシ

そういう意味で「いいから黙ってコメント書け」は「コメントなんて書くな」とどっこいどっこいに言いすぎ感あり。コードだろうがコメントだろうがなんだろうが「ちゃんと考えて書け」

このコメントは考えてないっぽいな、このコードは考えてないっぽいな、このドキュメントは考えてないっぽいな。どれも同様に駄目だと思うのであります。

 

自分はコードには結構コメント少ないような気がしますが、interface の周辺はコメントだらけになる傾向があり、そこにコードという表現ができないからコメントをベタベタと書く。interface の定義にコメントでこういう実装をしろよと丸々コードをコメントで書いとくとかもあるし。

 

自分ローカルな問題かもしれんけど、コメントの最大の問題は「コメントを書く為に考えた事によってやったつもりになってコードを書くのを忘れる事が多い」って事。(ぉぃ

 

投稿日時 : 2009年9月16日 12:34


コメントを追加

タイトル
名前
URL
コメント