はじめに
こんにちは。巷で有名なアドベントカレンダーを、一人で書いてみよう企画になります。
通常アドベントカレンダーはクリスマスまでですが、もうちょっとおかわりして、31日まで駆け抜けます。
今回のテーマは「コメントを書く／書かない基準」です。
コメントを書く／書かない基準
これに関しては、実装意図を明示する必要がある場合にコメントを書くように心がけています。
確か新人時代に読んだ、リーダブルコードという名著にそのような旨が書かれていたのを読んだことがきっかけだったように記憶しています。
単にコードの内容をトレースするだけのコメントは不要（読めばわかるので）、
なぜこのタイミングで変数に値を入れているのか、この構造体で何を実現しようとしているのか、このメソッドの責務は何か、
などなど、実装読むだけでは伝わりきれない意図がある場合はコメントを残すようにしています。
あと不具合やエラー等の対応でこうしている、という旨のコメントを残すこともよくあります。
自分が書いたコードであっても時間が経つと忘れてしまいますし、他人がコードを読むとなったらより一層ですね、、
コードリーディングのコストを下げるための工夫として意図がしっかり伝わるように適宜コメントを残すようにすることが、
実装時の迷いを軽減し、アウトプットスピード・質の向上につながると思っています。
終わりに
今回は以上です！
それではまた明日！
