Linux(Ubuntu)サーバとダーツを愛する中年サラリーマンの日記。

Linuxサーバより愛を込めて。

プログラミング

プログラムとコメントについて

投稿日:

先日他人様のブログを拝見していて「なるほどなぁ・・・」と思った記事がありましたのでご紹介します。

 

「コメントを書かない言い訳」に関する考察

 

各プログラム言語にはソースの中にコメントを挿入できるようになっていますよね。

 

内容としては「コメントを書こう」ではなく「書かない理由を潰そう」「書くからには意味を考えて」という趣旨だと解釈したんですが。

 

まずコメントを入れない理由として挙げられているのが大別して

  • コメントがなくても分かるコードを書くべき
  • コメントを書くことによる生産性の低下

の2つ。

 

分かりやすいコードを書くのは当たり前の話だと思うのですが、筆者の方がおっしゃるとおり「誰が見てもすぐ理解できる」コードを書くというだけですでにハードル高すぎだと思うわけです。

 

しかもコードを読んだところで「その挙動に至る過程や実装を書いた意図」は推測することしかできないと。

 

まさにそのとおりだと思いました。

 

ということで「処理内容ではなく意図を書くこと」こそコメントの存在意義なのだということが1つ。

 

あとは生産性について。

 

コメント書くのにどんだけ時間かかるんだ!?という話。これも最もな話だと思います。

 

文のなかでは「トランス状態」のように一気に書き上げたい時に随時入れる必要はないが、そのときの思考回路を後で振り返ることで「過去の全力トランス」を「ノーマル五分の力」で書けるようになると。

 

そのためにも、後でもいいからコメントを書いて整理するべきだと。もちろん引き継いで他の人が見たときのためにも。

 

自分の場合、時間を置いてコードを見直したときに訳が分からなくなることもあるためなるべくコメントを入れるようにしていました。

 

そんな理由でかくコメントですから、処理内容ではなく「どんな考えでこんな処理にしたか」が箇条書きみたいになってることが多いんですが、あながち間違いでもなかったのかな~と一人でほくそ笑んでたりしてます。

 

自分が今の職場を離れて、後任に渡すときに少しでも判りやすい状態で引き渡せれば…と考えるとコメントひとつとっても色々と考えるきっかけになったのでした。

 

スポンサードリンク

スポンサードリンク

-プログラミング
-

Copyright© Linuxサーバより愛を込めて。 , 2017 All Rights Reserved Powered by STINGER.