なぜ、コメントを書くべきなのか？（A Philosophy Of Software Designより）

株式会社DMM Boostの社内勉強会のLT資料です。

100. A Philosophy of Software Design (1/3) w/ twada

https://fukabori.fm/episode/100

引用させていただいた、t_wada氏のポストはこちらです。

https://x.com/t_wada/status/1841989672555462696

Transcript

1. 2022/03/03 なぜ、コメントを書くべきなのか？ （A Philosophy Of Software Designより） 株式会社DMM Boost 社内勉強会（2024/11/12） 矢島 達朗
2. 自己紹介 所属：株式会社DMM Boost 名前：矢島 達朗（Tatsuro Yajima） ① チ。―地球の運動について ― ② るろうに剣心 京都動乱 最近楽しみにしてること
3. 議題 1. 書籍の紹介 2. なぜ、コメントを書くべきなのか？ 3. どうやって、コメントを書くべきなのか？ 4. まとめ
4. 議題 1. 書籍の紹介 2. なぜ、コメントを書くべきなのか？ 3. どうやって、コメントを書くべきなのか？ 4. まとめ
5. 書籍の紹介 A Philosophy Of Software Design John Ousterhout(著)（以下、John先生） ソフトウェアの複雑性を減らす方法についての書籍。 - 複雑性を減らすにはどうするか？ - 複雑性を減らす設計 - 複雑性を減らすコメント fukabori.fm(Podcast)でも紹介されています。 - https://fukabori.fm/episode/100
6. 議題 1. 書籍の紹介 2. なぜ、コメントを書くべきなのか？ 3. どうやって、コメントを書くべきなのか？ 4. まとめ
7. Q. なぜ、コメントを書くべきなのか？ A. 「設計の質を上げられるから」
8. Q. なぜ、コメントを書くと設計の質が上がるのか？ A. コメントを書くことで、以下のメリットがあるためです。 • メリット1. システムの複雑性を隠蔽することができる • メリット2. 読み手が、コードを読まなくても良い状態にできる
9. メリット1. システムの複雑性を隠蔽することができる コメントを書くことで、コードを抽象化できます。 コードを抽象化することで、コードの複雑性を隠蔽できます。 わかりやすい！
10. メリット2. 読み手が、コードを読まなくても良い状態にできる なるほど！
11. 議題 1. 書籍の紹介 2. なぜ、コメントを書くべきなのか？ 3. どうやって、コメントを書くべきなのか？ 4. まとめ
12. Q. どうやって、コメントを書くべきなのか？ A. コードを書き始めるより先にコメントを書くべき！ 　 以下のメリットがあります。 • メリット1. 質の高いコメントが書ける！ • メリット2. 設計を改善できる！ • メリット3. コメントを書くのが楽しくなる！
13. メリット1. 質の高いコメントが書ける！ 先にコメントを書くことで、質の高いコメントを書くことができます。 なぜなら、設計の意図をコメントすることができるためです。 ここには、エラーを検知するため のメソッドを書こう！
14. 先にコメントを書くことで、設計を改善できます。 なぜなら、コメントによって設計を見直すきっかけになるためです。 メソッドを2つに分けた方がいいかな？ メリット2. 設計を改善できる！
15. メリット3. コメントを書くのが楽しくなる！ 先にコメントを書くことで、コメントを書くのが楽しくなります！ なぜなら、コメントを書くこと（＝ 設計）は、開発の醍醐味だからです。 商品の値段を引数でもらって、値引きを してから売値を返せばいいか。 ついでに在庫の有無も確認しよう！ （楽しい！）
16. 議題 1. 書籍の紹介 2. なぜ、コメントを書くべきなのか？ 3. どうやって、コメントを書くべきなのか？ 4. まとめ
17. まとめ Q. なぜ、コメントを書くべきなのか？ A. 「設計の質を上げられるから」 コメントを書くメリット 1. システムの複雑性を隠蔽することができる 2. 読み手が、コードを読まなくても良い状態にできる Q. どうやって、コメントを書くべきなのか？ A. コードを書き始めるより先にコメントを書くべき！ コメント、書いていきましょう！
18. おまけ① アンクル・ボブ氏とジョン先生の違い アンクル・ボブ（Robert C. Martin）氏は、コメント否定派。 著書『Clean Code』のなかで以下のように述べています。 コメントはせいぜい必要悪だ。 もし私たちのプログラミング言語が十分に表現力豊かであれば、 あるいは私たちにその言語を巧みに操り、私たちの意図を表現す る才能があれば、コメントはあまり（おそらくまったく）必要な いだろう。 メソッド名、変数名で処理内容がわかるコードを書こう！
19. おまけ② コメントについての個人的考え ベストは コメント不要なコードを書きながら、コメントもしっかり書くこと！ 以下の、t_wada氏の考えに同意します！ 出典: X(リンクはこちら)
20. ご清聴ありがとうございました！