プログラマーが知るべき「良いコメント」の条件【第5回】

プログラマーが「駄目なコメント」をソースコードに残さないための5カ条

読んだ人がソースコードを素早く理解しやすくなる「良いコメント」には、幾つかの要件がある。プログラマーが押さえるべき、良いコメントを書くための要件5つを紹介する。

　プログラミング言語の要素のうち、プログラマーにとって簡単なようで難しく、奥が深いのが「コメント」だ。自分だけではなく、ソースコードを読んだ全ての人が分かりやすいコメントを書くことは、プログラミングをスムーズに進める上で重要になる。「良いコメント」の条件を、あらためて考えよう。

駄目なコメントではなく「良いコメント」を書く条件

TechTarget発　エンジニア虎の巻

米国TechTargetの豊富な記事の中から、開発のノウハウや技術知識など、ITエンジニアの問題解決に役立つ情報を厳選してお届けします。

この連載の記事をもっと見る

この記事の著者

関連記事

• 

  「Python」と「Go」のソースコードを比べて分かる「インデント」の違いとは？

• 

  命令型プログラミングと宣言型プログラミングの「ソースコード」の違いとは？

新着ホワイトペーパー PR

• 技術文書・技術解説
  [アトラシアン株式会社] IT運用や従業員サポートは生成AIでどう変わる？　使い方や導入の流れは？
• 製品資料
  [株式会社みらい翻訳] 音声翻訳活用の課題を解決、“本当に使える”ツールの特徴とは？
• 製品レビュー
  [Wrike Japan 株式会社] 400店舗を支えるWalmart Canada、散在する情報やアナログな管理をどう変えた？
• 事例
  [Wrike Japan 株式会社] 年間100件超のDXプロジェクトを統合管理、JERAはどのように実現した？
• 事例
  [Wrike Japan 株式会社] グローバルなクリエイティブ業務を合理化、エスティーローダーに学ぶ実践のコツ