コメントアウトするべきでは「ない」こと

Transcript

1. コメントアウト
 するべきでは
 「ない」こと
 三海 純(ミカイジュン)

2. 自己紹介
 • 三海純(ミカイ ジュン)
 • フリーランスエンジニア
 ◦ Next.jsの新規開発 + Laravel
 ◦ Python API新規開発・設計
 • 趣味
 ◦ アニメ(BanG Dream!・ぼざろ 等)
 ◦ ネット麻雀(雀魂・雀豪)

3. キャリア
 • 2020/06 - 2022/02: 正社員(受託企業)
 ◦ Vue.js/Nuxt.jsをメイン
 • 2022/03 - 2023/09: 正社員(自社開発)
 ◦ バックエンドはPython / Nest.js(Node.js)
 ◦ フロントエンドはReact.jsとNext.js
 • 2023/10 - : フリーランス(自社開発)
 ◦ Next.jsの新規開発とバックエンドを担当
 ◦ Python APIの新規開発・設計

4. この本はご存知ですか？
 

5. 今回のゴール
 紹介される
 エンジニア書籍
 No.1 !!!
 ※個人の感想です

7. 冗談はおいておき
 コードの書き方の
 有名な書籍です

8. 今回は・・・
 5章 コメント
 すべきことを知る
 について紹介したいと思います

9. // 金額を計算する const calculatePrice = (price, quantity) => { // priceとquantityをかけて合計を計算 return price * quantity } const price = calculatePrice(1000, 3)
10. コメント必要ですか？
 // 金額を計算する const calculatePrice = (price, quantity) => { // priceとquantityをかけて合計を計算 return price * quantity } const price = calculatePrice(1000, 3)
11. 実際に後輩から言われたこと
 (コードからわかることでも)
 コメントがあった方が
 すぐにわかる
 からコメント書きたい
 

13. とはいえ・・・
 - 前提知識があると無駄なコメ ント邪魔になる
 - 本当にコメントが必要な箇所 を見逃す

14. 日常会話で解説

15. 今日何が食べたい？ カツ丼！ わかった！か◯やで買ってくるね！
16. ここで問題です。どちらの
 カツ丼を買ってくるでしょうか？

17. 正解は・・・

18. 解説
 引用元: https://www.arclandservice.co.jp/katsuya/menu/
19. 質問です。なぜ
 わかりましたか・・・？

21. 日本国内において最も一般的なカツ丼のスタイルは、
 
 「豚カツとタマネギを醤油味の割下で煮込み、卵とじ にして、米飯にのせた料理」である。
 
 単に「カツ丼」と呼んだ場合は、
 一部地域（特に福井県、山梨県、群馬県、岡山県、沖縄県、長野県の南部） 
 を除いてこの形態を基本とする。
 一応解説
 引用元: https://ja.wikipedia.org/wiki/%E3%82%AB%E3%83%84%E4%B8%BC
22. つまり、みなさんは
 「カツ丼」に関して
 前提知識がある
 ってことになるんですよ

23. つまり赤枠部分が「カツ丼」になる
 // 金額を計算する const calculatePrice = (price, quantity) => { // priceとquantityをかけて合計を計算 return price * quantity } const price = calculatePrice(1000, 3)
24. 今日何が食べたい？ 豚カツとタマネギを醤油味の割下で煮込み、卵 とじにして、米飯にのせた料理！ つまりカツ丼！ ん？どういうこと？ か◯やでいいんだよね・・・？
25. 問題点1: 前提条件知ってる
 豚カツとタマネギを
 醤油味の割下で煮込み、
 卵とじにして、米飯にのせた料理
 
 つまりカツ丼！
 

26. 問題点2: 
 ノイズで正解を掴みにくい
 〇〇とタマネギを
 醤油味の割下で煮込み、
 卵とじにして、〇〇にのせた料理
 

28. 再掲載
 - 前提知識があると無駄なコメ ント邪魔になる
 - 本当にコメントが必要な箇所 を見逃す

29. 週末はカツ丼ライフを！

30. ではなく、
 良い開発ライフを！

31. ご清聴ありがとうござ います！