TechTargetジャパンエンジニア読本集
「駄目なコメント」をソースコードに残さない方法
ソースコードの理解を助けるために残したはずのコメントが、本来の役割を果たさないことがある。悪いコメントの条件とは何か。良いコメントを書くには、何に気を付ければよいのか。実例と共に解説する。
ソースコードに存在する「コメント」は、ソースコードを読む人の理解を助けるための、プログラミングの基本的な要素だ。にもかかわらずコメント本来の役割や、正しいコメントの書き方に関する理解が浸透しているとは言い難い。
良いコメントを残すことができれば、書いた本人だけではなく、それ以外の人にとっても扱いやすく、理解しやすいソースコードを記述する助けになる。本資料は、プログラミング言語「Python」で実装した例を参照しながら、悪いコメントとは何なのか、良いコメントを残すためには何に注意すればよいのかを整理する。
中身を読むには、「中身を読む」ボタンを押して無料ブックレットをダウンロードしてください。
連載：プログラマーが知るべき「良いコメント」の条件
Copyright © ITmedia, Inc. All Rights Reserved.
TechTargetジャパンエンジニア読本集
ITエンジニア向け連載記事「TechTarget発 エンジニア虎の巻」をまとめたPDFブックレット「エンジニア読本」を紹介します。
こんなメディアも見られています
TechTargetジャパンに関連する情報をお探しであれば、こちらのメディアもお役に立てるかもしれません。
ベンダーコンテンツ PR
From Informa TechTarget
SpecialPR
アクセスランキング
-
1
「Excel至上主義」の終わらせ方 丸2日の手作業地獄から情シスと現場を救うには
-
2
急増する「AIはこう言ってる」マン 判断を狂わせる「AI忖度」を防ぐには？
-
3
取手市がVDIと決別した理由 更改費用「4倍超」を約1.7倍に圧縮
-
4
221人調査で分かった「情シス最大のストレス」は？
-
5
「データストレージの活用方法」に関するアンケート
-
6
「AI時代の統合基盤・エンタープライズAI管理」に関するアンケート
-
7
自宅のWi-Fiが「遅い」「途切れる」本当の原因は？ Dellが推奨する鉄則
-
8
100億円の「Linux更新」を回避 みずほ銀行が選んだ“おきて破り”のRHEL延命策
-
9
本当に安いPCで十分か？ “すぐ重くなる”を防ぐノートPC選びの絶対条件
-
10
Claudeの不可視透かしに批判殺到 著作権消失や誤判定に潜む企業リスク
ホワイトペーパーランキング PR
-
1
年収2000万「クラウドセキュリティのプロ」になれる資格とは
-
2
セキュリティソフトをすり抜ける標的型攻撃メール、不審メールの見破り方とは？
-
3
Windows Updateの通信集中で回線が逼迫、ネットワーク刷新事例に学ぶ解決策
-
4
財務を戦略的組織へ進化させるAI活用術、4つの主要な障壁と解消方法
-
5
「NAS」「SAN」「DAS」は何が違う？ いまさら聞けないストレージの基礎
-
6
“あのファイル転送”で暗躍するノーウェアランサム
-
7
標的型攻撃メールを見破るには？ サンプル文面を例に傾向を解説
-
8
商用利用の安全性を確保し大量のコンテンツを高速で生成する、AI活用の秘訣
-
9
マンガで解説、1日で生成AI環境を構築できるワークショップの中身とは？
-
10
Dark AIが台頭する時代の新発想、「より高度なAIで対抗する」具体的方法とは？
TechTargetジャパン SNS
@techtarget_itmをフォロー
インフォメーション
注目情報をチェック
TechTargetジャパンをフォロー