rinkou_15

Transcript

1. Chapter 15 Write The Comments First (Use Comments As Part Of The Design Process) 1
2. Chapter 15 コメントを最初に書く （設計プロセスの一部としてコメントを活用する） 2
3. 多くの開発者は、コーディングとテストがすべて終わる開発プロセスの最後まで、 ドキュメント作成を後回しにする しかし、これでは質の低いドキュメントを生み出してしまう コメントを書くのに最適なタイミングは、コードを書く前、つまりプロセスの最 初 コメントを最初に書くことで、ドキュメント作成を設計プロセスの一部に組み込 むことができる ドキュメントの質が向上するだけでなく、設計そのものが洗練され、ドキュ メント作成という作業自体もより楽しいものになる 3
4. 15.1 後回しにされたコメントは「質の悪い」コメントである なぜ後回しにするのか？ 後回しにした場合の弊害は？ 4
5. なぜ後回しにするのか？ 「コードがまだ変わるから」という理由が多い コードを修正する度にコメントも修正するのは非効率なので、コードが完成 するまで待ったほうが効率的だという理屈 5
6. 後回しにした場合の弊害は？ 結局書かれずじまいになる コードが安定したら書こう → ドキュメントの無いコード量が膨大 → ドキュメ ント作成のタスクも膨大 → それよりバグ潰したり新機能追加の方が大切だ 数日間作業を止めて、抜けているドキュメントを全て作成する都合の良いタ イミングなんて、いつまで待っても来ない 設計から時間が経っているので記憶が曖昧 コードを見ながらコメントを書くため、コードの内容をそのままなぞるだけ のコメントになりがち 6
7. 15.2 まずコメントから書き始める 1. 新しいクラスを作成するときは、まずクラスのインターフェース・コメントを書く 2. 最も重要なパブリック・メソッドのインターフェース・コメントとシグネチャを書 く。メソッドの中身は空のまま。 3. 基本構造がしっくりくるまで、1,2を何度か練り直す 4. クラス内の主要なインスタンス変数の宣言とコメントを書く 5. メソッドの中身を埋め、必要に応じて実装コメントを追加する コードが完成した時には、コメントも完成している！ 7
8. 「コメント先出し」アプローチのメリット① コメントの質が向上する クラスを設計しながらコメントを書けば、設計上の重要な論点が記憶に新し いため、記録しやすい 実装前にインターフェース・コメントを書くことで、実装の詳細に惑わされる ことなく、そのメソッドの「抽象化」と「インターフェース」に集中できる 実装フェーズでコメントの不備に気付くので、コメントの質は更に向上する 8
9. 15.3 設計ツールとしてのコメント 「コメント先出し」アプローチのメリット② システムの設計が改善される（最も重要なメリット） 優れたシステム設計において、抽象化は不可欠 コードに現れない情報を記録できるのはコメントだけ 良いコメントを書くには、 「使う人が知るべきことは何か」を見極める必要がある これを設計プロセスの初期に行うことが大切 9
10. 抽象化は「深く」あるべき（第4章） 優れたクラスとは、インターフェースは極めてシンプルでありながら、強力な 機能を実装しているもの コメントは「深さ」を判断するツールになる インターフェース・コメントが短くシンプルなら → インターフェースが 複雑でない証拠 コメントより実装が明らかに多い → 「深い」クラスである証拠 10
11. コメントが書きにくければ、設計を見直すサイン メソッドや変数を説明するコメントは、シンプルでありながら完全であるべき もしそのようなコメントを書くのが難しいと感じたら、それは設計そのものか、 説明しようとしている対象に問題があるサイン 11
12. 15.4 最初に書くコメントは楽しい 「コメント先出し」アプローチのメリット③ プログラミングで最も楽しい時間の一つは、新しいクラスの設計初期段階（著者 談） コメントがシンプルであればあるほど、自分の設計に自信を持つことがで き、簡潔な表現を見つけることは誇りにも繋がる 優れた設計を目指す「戦略的プログラミング」を実践するなら、コメントを書く ことは最良の設計を見極める手段となり、楽しい作業になるはず 12
13. 15.5 最初に書くコメントは「コスト」が高いか？ コメントを先に書くと開発スピードが落ちる？ コメントを先に書くことで、コードを書き始める前に抽象化が安定 コーディング中の手戻りを減らし、時間を節約できる可能性が高い 13
14. 15.6 結論 ぜひ「コメントを最初に書く」という方法を試してみてください 慣れるまで根気よく続けてみてください そして、それがコメントの質、設計の質、そしてソフトウェア開発の楽しさにど う影響したかを考えてみてください 14