TechTargetジャパンエンジニア読本集
「駄目なコメント」をソースコードに残さない方法
ソースコードの理解を助けるために残したはずのコメントが、本来の役割を果たさないことがある。悪いコメントの条件とは何か。良いコメントを書くには、何に気を付ければよいのか。実例と共に解説する。
ソースコードに存在する「コメント」は、ソースコードを読む人の理解を助けるための、プログラミングの基本的な要素だ。にもかかわらずコメント本来の役割や、正しいコメントの書き方に関する理解が浸透しているとは言い難い。
良いコメントを残すことができれば、書いた本人だけではなく、それ以外の人にとっても扱いやすく、理解しやすいソースコードを記述する助けになる。本資料は、プログラミング言語「Python」で実装した例を参照しながら、悪いコメントとは何なのか、良いコメントを残すためには何に注意すればよいのかを整理する。
中身を読むには、「中身を読む」ボタンを押して無料ブックレットをダウンロードしてください。
連載：プログラマーが知るべき「良いコメント」の条件
Copyright © ITmedia, Inc. All Rights Reserved.
TechTargetジャパンエンジニア読本集
ITエンジニア向け連載記事「TechTarget発 エンジニア虎の巻」をまとめたPDFブックレット「エンジニア読本」を紹介します。
新着ホワイトペーパー PR
-
技術文書・技術解説
[Jamf Japan 合同会社] MDMだけでモバイルセキュリティは十分？ 不足する対策を16項目でチェック -
事例
[Wrike Japan 株式会社] 世界的な家電メーカーが実践する「クリエイティブプロセス効率化」の方法とは？ -
事例
[Wrike Japan 株式会社] 世界的テクノロジー企業に学ぶ、プロセス標準化とプロジェクト納品自動化の秘訣 -
事例
[Wrike Japan 株式会社] ソニー・ピクチャーズ テレビジョンに学ぶ、次世代サービスデリバリーのヒント -
事例
[Wrike Japan 株式会社] ソミック石川に学ぶ、ICT浸透後に直面した「工数管理」の課題と解決策
こんなメディアも見られています
TechTargetジャパンに関連する情報をお探しであれば、こちらのメディアもお役に立てるかもしれません。
ベンダーコンテンツ PR
From Informa TechTarget
SpecialPR
アクセスランキング
-
1
「Copilot」はなぜ放置される？ “議事録要約止まり”を脱する処方箋
-
2
脱VMwareの前提が崩れる BroadcomのVDDK公開停止で確認すべき点
-
3
「有線LAN環境」に関するアンケート
-
4
AI全部入り「Microsoft 365 E7」に企業が二の足を踏む訳 移行意向はわずか4％
-
5
AWS障害でも補償ゼロの衝撃 サイバー保険で情シスが見落とす「細則の壁」
-
6
APIとは何か？ Web APIとの違い、利用者のタスクを解説
-
7
「データストレージの活用方法」に関するアンケート
-
8
100億円の「Linux更新」を回避 みずほ銀行が選んだ“おきて破り”のRHEL延命策
-
9
「データを国内に置く」だけでは不十分 情シスが知るべきAI時代の「デジタル主権」
-
10
「自動化」で「DX」は強制的に進む？ そのシンプルな理由
ホワイトペーパーランキング PR
-
1
マンガで解説：「ゼロトラスト」「SASE」の必要性とメリット
-
2
5回聞くだけじゃ足りない？ トヨタ式「なぜなぜ分析」の正しい実践方法
-
3
インシデント対応工数を約3割削減、東京ガスの事例に学ぶ監視体制刷新のコツ
-
4
AIエージェントで多様な日常業務を効率化するための入門ガイド
-
5
JR西日本ITソリューションズが「監視業務の属人化」を解消した方法とは？
-
6
国税庁の次世代基幹システム「KSK2」稼働開始に向けて、対応すべき変更点とは？
-
7
5分で分かる「セキュア大容量ファイル転送サービス」の機能とメリット
-
8
ドラマで分かる、標的型攻撃メールの被害を受ける企業と回避できる企業の分岐点
-
9
「脱Excel」か「Excel快適化」か？ 現場にやさしい業務改善の進め方
-
10
少額減価償却資産が40万円未満へ拡大、令和8年度税制改正で押さえるべき変更点
TechTargetジャパン SNS
@techtarget_itmをフォロー
インフォメーション
注目情報をチェック
TechTargetジャパンをフォロー