« [備忘録 / .NET] アプリにタブを実装する・いじくる | トップページ | [備忘録] ファイルシステム比較表 »

2007/11/12

[ニッキ] コメントは自分のための覚書じゃない

少なくとも、業務で、チームの一員として書いたコードでは。

業務で、チームの一員として書いたコードのコメントってのは、メンバーのために書くものだと思う。

デバッグのための役に立つ情報かもしれないし、あまり知られていないアルゴリズムを解説するものかもしれない。

「いいコメント」の例は Python の DocString だろう。Python の標準モジュールの DocString は自分のためではなく、Python を使う開発者 ( つまりユーザ ) のために書かれている。そのメソッドの引数は何か、何をするのか、戻り値として何を返すのかといった自分以外の開発者にとって有益なことが書かれている。

少なくとも、


int hoge = 32; // 数値に意味はない

なんてのはコメントのうちに入らない ( 数値に意味がないならなんで代入してるんだ? ) し、


// XXX
void functionname( args ){
....( 以下略 )

なんてのは論外だ ( XXX って何だよ?これみて何を理解しろってんだ? )

個人で趣味で書いたコードならどう書いてもいいと思うけどね。

わたしは Python の DocString のようなコメントを心がけて行こう。

2007.11.14 追記
なんか誤解されていたので追記。
XXX って書いてあること自体は悪いことじゃない。
悪いのは XXX だけ しか書いていないことだ。

# XXX ( 確かめなきゃいけないこととか )
↑みたいに「何をしなければならないのか」とか「なにが不確かなのか」といったメッセージが書かれているのならばそれでいいと思う。

|

« [備忘録 / .NET] アプリにタブを実装する・いじくる | トップページ | [備忘録] ファイルシステム比較表 »

コメント

コメントを書く



(ウェブ上には掲載しません)


コメントは記事投稿者が公開するまで表示されません。



トラックバック

この記事のトラックバックURL:
http://app.cocolog-nifty.com/t/trackback/103108/17054019

この記事へのトラックバック一覧です: [ニッキ] コメントは自分のための覚書じゃない:

« [備忘録 / .NET] アプリにタブを実装する・いじくる | トップページ | [備忘録] ファイルシステム比較表 »