IT製品導入に関する技術資料を多数掲載 ホワイトペーパーダウンロードセンター
  • @IT
  • ITmedia エンタープライズ
  • ITmedia マーケティング
  • TechTarget
  • キーマンズネット
  • ITmedia ビジネスオンライン
  • ITmedia NEWS

アイティメディア株式会社

プレミアムコンテンツ

アイティメディア株式会社

「駄目なコメント」をソースコードに残さない方法

コンテンツ情報
公開日 2023/09/01 フォーマット PDF 種類

プレミアムコンテンツ

ページ数・視聴時間 7ページ ファイルサイズ 747KB
要約
「駄目なコメント」をソースコードに残さない方法
 ソースコードに存在する「コメント」は、ソースコードを読む人の理解を助けるための、プログラミングの基本的な要素だ。にもかかわらずコメント本来の役割や、正しいコメントの書き方に関する理解が浸透しているとは言い難い。

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