今日の雑記

<< 2004/06 >>
1 2 3 4 5
6 7 8 9 10 11 12
13 14 15 16 17 18 19
20 21 22 23 24 25 26
27 28 29 30

back to TOP PAGE

 | 

2004-06-24

[]ソースコメント

とりあえず書く元になったネタから。

http://d.hatena.ne.jp/ABA/20040623

それについてのコメントで、

ABA 『コメントを書かなければならないようなコードを書いたら負け、っていう考えですかね。でも熟練者から初心者までみなに広く理解可能なコードを書くのは難しいから、やっぱりある程度はコメント必要かと。』

これを読んで、「はて?ボクは今書いてるソースに対して、何のためにコメント書いてるんだっけ?」と考えてしまいましたよ。

ボクはソースコメントを書く時に、ある程度は「これを読む他人のため」に書いてはいますが、実はわりと「未来の自分のため」に書いたりしてます。なんで、書いている内容とかが「自分向け」だったりしてるんですよねー。

そもそも、「何のために」コメントをつけるのか?という話になってくるんですけど、理想は「一見して何か解らない変数や値や処理」に対して書くのかなー?でも、「一見して解らない」それらの物を書いた時点で負け、ってことになりますしね。

カーニハン氏著の「プログラミング作法」には確か、例として「ソース引用した出典」とか「その関数テストに利用した値」とか、「具体的な性能の数値」とかを書いたコメントを例として挙げてたような気がしますが、今手元にその本が無いので確証が持てません。ごめんなさい。

そもそも、「初心者に対してのコメント」と「それ以上の人に対してのコメント」というのは、性質が違うような気がする。前者が「教本的」なのに対して、後者が「実用的」とでも言ったら良いのだろうか?いや、まあ、あたりまえか。

間違い無く言えるのは、今のボクがつけているコメントは、あまりにも「自己中心的」なコメントということだ。そんなやつがしたり顔でこんなこと書くなよ。

トラックバック - http://d.hatena.ne.jp/isshiki/20040624
 | 
20040203040506070809101112
20050102030405060809101112
2006010203040506070809101112
2007010203040506070809101112
2008010203040506070809101112
2009010203040506070809101112
2010010203040506070809101112
2011010203040506070809101112
2012010203040506070811
201301020708101112
20140203040509101112
2015010203040506070809101112
201601020304101112
20170405091012
201801020410
プロフィール

isshiki

isshiki

上級NEETの実態