プログラミングコメントの話

どうも、はかせです。
今回はコメントについてです。

処理の説明をするものですね。
書き方は言語によって変わるようですが私が最近使っているC++だと

//1行コメント
/*
複数行コメント
*/

こんな感じですね。

ここに書かれた内容はコンピュータには無視されるので
プログラマーが自由に文を入れることが出来ます。

多分誰しもが最初に思うことだと思います。
なぜなら処理は全てプログラミング言語で記述されているからです。
なのにわざわざコメントとして入れる必要があるのか？
当然出てくる疑問だと思います。

ただある程度プログラミングをやっていき
自分以外の人が書いたコードを読んでいると
「なんでここでこの処理やってんの？」
「この変数の意味は何？」
みたいな
何をやっているか
ではなく
何故やっているか
という疑問が出てくると思います。
この疑問を解決するのがコメントの役割です。

コメントとしてやっている理由を残しておけば
自分以外の人が読んだ時コードと抱き合わせで読むことで
何をやっていて何故やっているのかが口で説明しなくても
ある程度伝わるようになります。

つまりよく色んな所で言われる
可読性の向上に大きく貢献してくれるのがコメントです。

ぶっちゃけこれはケースバイケースだと思います。
全てのコードに書いていたらくどすぎますし、
なさすぎても困ります。

よく言われるのは
コード全体量の3分の1程度
コメントを追っていくだけで処理のフローチャートが書けるくらい
って感じですね。

今回はコメントの話でした。
何故この話をしようかとおもったかというと
私自身の戒めという意味合いが強いですかね。

というのもバグフィックスや実装を急いでいたりすると
コメント書くの忘れてしまうことが多いんですよね。
(そして後で直すときにコメントが無くて涙を流す・・・orz)

そして地味に性質が悪いのは最近個人開発が多いということです。

私自身最近技術向上ということでC++を個人でやっていることが多いです。
個人でやっているので処理の流れは頭の中に入っていますし、
意味もわかります。

ただそうすると読んでわかることをコメントにわざわざ
書かないので必然的にコメント量が減っていきます。
そして結果数ヶ月後の自分や周りの人が泣きを見るっていう結果になります。

なのでこうしてアウトプットしてみました。

それでは今回はこの辺でノシ

はかせのラボ