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

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

[TechTargetジャパン運営事務局]

ダウンロードはこちら

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

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

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

TechTargetジャパンサービス利用登録はお済みですか？

「TechTargetジャパン」メンバーシップのご案内

会員登録をすることで、技術資料がそろったホワイトペーパーや興味・関心分野ごとに情報を配信するメールマガジン、特集記事がPDFでまとまって読める電子ブックレットなど、各種サービスを無料で利用できます（TechTargetジャパンサービス利用登録）。