ソースコード中のコメント

他人のコードをレビューしたり改修したりする機会が最近増えた。

あるコードがどのような意図を持って実装されているのかを考えなければならくなったとき、(i)単純に実装者が勘違いや誤りに気付かなくて現状の実装に なっている、あるいは(ii)自分の能力不足のために実装者の意図をつかみきれていない、のいずれなのかわからないことがある。

そういったとき、参考になるのはやはりコード中のコメントとなる。
書いてある内容が直接問題解決に結びつかない場合でも、どの程度の考慮を持って実装を行ったのかを推測する材料になるし、日本語の文章として見たときの記 述レベルから本人の能力を推し量れたりもする。

ソースコード中にコメントを書くくらいなら、コメントを読まなくても理解できる様にコードを書け、という主張をしばしば聞くことがある。
この意見を全面的に否定するわけではないが、(i),(ii)はコード以外に材料が無ければ判断できない事もこの2年間少なくなかった。


後になってみると単純なことが、事前には全くリスクとして検討されないまま事が進み大事になってしまう、という体験をこの2年間でよく目にした。
この業界はプロジェクトの遂行についてリスクを過小評価、というより列挙されるリスクの数自体が少なすぎる傾向があるように思われる。
つまらない(少なくとも傍からはそう見える)リスクにつまずいているプロジェクトを見ると、プロジェクトが実行に移る前まではもうちょっと大げさに事を運 んでも良いのでは、と常々思う。少なくとも後で大騒ぎをするよりは。

この4月から社会人3年目。
新人と呼ばれるのは今年くらいまでだろうか。