最小限のコメント

高木です。おはようございます。

私はプログラマーなので、自分でソースコードを書く機会も結構あります。
というか、日常的にコーディングを行っています。

その際、自分の頭の中ではプログラミング言語で直接考えています。
プログラミング言語以外も併用しますが、それは多くの場合数式です。

そんな感じで頭の中でプログラムを組み立て、脳内デバッグも行った上で、そのアウトプットとしてコーディングを行っています。
といってもあまり時間がないことが多いので、脳内デバッグはコーディングしながら行うことのほうが多いと思います。

そんな状況なので、コメントはほとんど書きません。
コメントを書くと、そのたびに思考が中断され、脳内デバッグの精度が落ちるからです。

そんなやり方なので、結構難しいロジックでも、コーディングが終われば一発かそれに近い感じで動作することが多いのです。
もちろん、細部については、そこからさらに完成度を上げていく必要はあります。
異常系の処理なんかはとくにそうですね。

そんな私ですが、コメントを一切書かないかというとそうでもありません。
明らかにコメントが必要な箇所にはちゃんと記入します。
それと、APIの類はコメントないしは別のドキュメントに必要なことは記述するようにしています。

ファイルヘッダとか関数ヘッダのような、どうでもいいような形式的なコメントはほとんど書きませんね。
Doxygenでドキュメントを自動生成するために、後付けで書くことがあるぐらいです。

こんな感じなので、嫌われることも少なくありません。

もともとプログラミング言語で直接考えて、それをそのままタイピングするのは楽ですが、そこから日本語に翻訳するのは一苦労です。
中には日本語で考えてからプログラミング言語に翻訳するプログラマーもいるのでしょうが、その場合にはコメントとか内部設計書から入るんですかねえ。
私ならそんな非効率なことはしませんけど。

コメントを残す

メールアドレスが公開されることはありません。 * が付いている欄は必須項目です