「駄目なコメント」をソースコードに残さない方法TechTargetジャパンエンジニア読本集

ソースコードの理解を助けるために残したはずのコメントが、本来の役割を果たさないことがある。悪いコメントの条件とは何か。良いコメントを書くには、何に気を付ければよいのか。実例と共に解説する。

2023年09月01日 17時00分 公開
[TechTargetジャパン]
ダウンロードはこちら

 ソースコードに存在する「コメント」は、ソースコードを読む人の理解を助けるための、プログラミングの基本的な要素だ。にもかかわらずコメント本来の役割や、正しいコメントの書き方に関する理解が浸透しているとは言い難い。

 良いコメントを残すことができれば、書いた本人だけではなく、それ以外の人にとっても扱いやすく、理解しやすいソースコードを記述する助けになる。本資料は、プログラミング言語「Python」で実装した例を参照しながら、悪いコメントとは何なのか、良いコメントを残すためには何に注意すればよいのかを整理する。


中身を読むには、「中身を読む」ボタンを押して無料ブックレットをダウンロードしてください。

ALT ダウンロードはこちら

連載:プログラマーが知るべき「良いコメント」の条件

ITmedia マーケティング新着記事

news061.jpg

マーケターの87%は自分の仕事が生成AIなどのテクノロジーに取って代わられることを懸念――Gartner調査
Gartnerがマーケティング人材に関する調査を実施。環境的不確実性と技術的複雑性の中で、...

news058.jpg

Z世代が旅に求める「令和的非日常」とは?
JTBコミュニケーションデザインと伊藤忠ファッションシステムが、Z世代の旅に関する意識...

news094.jpg

電通が「AI×クリエイティブ」の強みを生かしたビジネスコンサルティングサービスを提供開始
電通は「AI×クリエイティブ」で企業の事業やサービスの開発を支援する新サービス「AIQQQ...