エントリーの編集
エントリーの編集は全ユーザーに共通の機能です。
必ずガイドラインを一読の上ご利用ください。
コードを読む人の助けになるコメントを書くために - Qiita
記事へのコメント0件
- 注目コメント
- 新着コメント
このエントリーにコメントしてみましょう。
注目コメント算出アルゴリズムの一部にLINEヤフー株式会社の「建設的コメント順位付けモデルAPI」を使用しています
- バナー広告なし
- ミュート機能あり
- ダークモード搭載
関連記事
コードを読む人の助けになるコメントを書くために - Qiita
コメントを書かなくても理解できるコードは簡潔で美しいです。 しかし現実には、ライブラリのバグ対応や... コメントを書かなくても理解できるコードは簡潔で美しいです。 しかし現実には、ライブラリのバグ対応や緊急リリースで時間が限られているなどで、その場しのぎのコードや応急処置的なコードを書かざるを得ないことがあります。 そのようなコードに何もコメントがないと、他の人や後から自分が見たときにそのコードの意図を汲み取ることが難しくなります。 場合によっては、リファクタリングの際に不必要なものとして削除されプログラムがリグレッションする可能性もあります。 そのようなことを防ぐために普段気をつけていることを紹介します。 「普通はこう書く」から逸脱するコードはなぜそれをするのか理由を書く 使用しているライブラリやSDKにバグがあって「普通はこう書く」というコードを書いても期待どおりに動かないことがあります。 そういうときは、一見すると稚拙で場当たり的に見えるコードを書かなければならないこともあると思います