リーダブルコード入門

DMTC勉強会で利用した資料です

Transcript

1. 第一回 リーダブルコード入門 株式会社ギブリー　 新田 章太
2. 過去のCAMP　開発実績 アジェンダ 1. リーダブルコードとは ‐ そもそもリーダブルコードとは ‐ なぜリーダブルコードが必要なのか 2. 命名規則 ‐ 命名規則とは？ ‐ 単語を明確に ‐ ループイテレータ ‐ プレフィックスとサフィックス 3. コメントアウト ‐ コメントすべきでないこと ‐ コメントは簡潔に 4. 演習問題
3. 過去のCAMP　開発実績 挨拶　自己紹介 新田章太(24) ・株式会社ギブリー　取締役COO兼CHO ・筑波大学理工学群社会工学類卒 ・エンジニア特化型のキャリア支援事業立ち上げ ・DMTC立ち上げ ・自社サービスの開発、運営、受託開発業務など
4. 過去のCAMP　開発実績 アジェンダ 1. リーダブルコードとは ‐ そもそもリーダブルコードとは ‐ なぜリーダブルコードが必要なのか 2. 命名規則 ‐ 命名規則とは？ ‐ 単語を明確に ‐ ループイテレータ ‐ プレフィックスとサフィックス 3. コメントアウト ‐ コメントすべきでないこと ‐ コメントは簡潔に 4. 演習問題
5. 1. リーダブルコードとは？ ・Dustin Boswell , Trevor Foucher (著) ・須藤 功平 (解説) ・角 征典 (翻訳) 「リーダブルコード」 こちらの書籍をもとに、学んでいきます。
6. 「読みやすいコード」 1. リーダブルコードとは？
7. 「読みやすいコード」 1. リーダブルコードとは？ 他の人が短時間で理解できるコード
8. 「読みやすいコード」 1. リーダブルコードとは？ 他の人が短時間で理解できるコード
9. “コードは他の人が最短時間で理解できるように 書かなければならない“ 1. リーダブルコードとは？ ※リーダブルコードより引用
10. なぜ必要なのか？ ・チーム開発 ・引き継ぎ 1. リーダブルコードとは？
11. 1.そもそもリーダブルコードとは？ 求められるもの ・命名規則 ・コメントアウト ・インデント／美しさ(順序) ・ループとロジックの単純化（ネストを最小化） ・分割方法（最適なまとめ方） ・再構成（汎用的なコードをつくる） などなど…
12. 1.そもそもリーダブルコードとは？ 今回触れること ・命名規則 ・コメントアウト ・インデント／美しさ(順序) ・ループとロジックの単純化（ネストを最小化） ・分割方法（最適なまとめ方） ・再構成（汎用的なコードをつくる）
13. 過去のCAMP　開発実績 アジェンダ 1. リーダブルコードとは ‐ そもそもリーダブルコードとは ‐ なぜリーダブルコードが必要なのか 2. 命名規則 ‐ 命名規則とは？ ‐ 単語を明確に ‐ ループイテレータ ‐ プレフィックスとサフィックス 3. コメントアウト ‐ コメントすべきでないこと ‐ コメントは簡潔に 4. 演習問題
14. 2.命名規則 命名規則とは？ 命名規則とは、 プログラミングを行う際に識別子の名称となる文字 列を決定するためのルールを定めたもの。 ネーミング規則、ネーミング規約、命名規約とも呼 ぶ。通常は、ソースコードの可読性や視認性の向上、 プログラミング効率の改善などを目的としている。 ※wikipedia参照
15. 2.命名規則 命名規則とは？ $camelCase ($CamelCase) $snake_case
16. 2.命名規則 命名規則とは？ “名前に情報を詰め込む”
17. 2.命名規則 単語を明確に
18. 2.命名規則 単語を明確に Makeって具体的に何をするの？
19. 2.命名規則 単語を明確に 単語 代替案 send deliver , announce , route , distribute find search, extract , locate , recover start launch , create , begin , open make create , set , build , generate , compose , add , new
20. 2.命名規則 ループイテレータ
21. 2.命名規則 ループイテレータ 慣習として　i j k を使うことが多い
22. 2.命名規則 ループイテレータ
23. 2.命名規則 ループイテレータ ネストが深くなるとミスに気づきづらい
24. 2.命名規則 ループイテレータ 具体例 デメリット 慣習的なもの $i , $j , $k ネストが深くなるとミスが出やすい 意味合いを持つ もの $index, $idx, $counter, $cnt 変数の頭文字を とる $ui,$cj,$mk
25. 2.命名規則 プレフィックスとサフィックス ・接頭語（プレフィックス） 状態や行為を表すときに用いることが多い ・接尾語（サフィックス） 　要素を補足するときに用いることが多い
26. 2.命名規則 プレフィックスとサフィックス
27. 2.命名規則 プレフィックスとサフィックス もし、ユーザーネームだったら？？
28. 2.命名規則 プレフィックスとサフィックス 接頭語 使用用途 is_◦◦ ◦◦かどうか has_◦◦ 既に◦◦かどうか can_◦◦ ◦◦が可能かどうか Should_◦◦ ◦◦なべきかどうか 条件分岐を意識すると良い
29. 2.命名規則 プレフィックスとサフィックス 接尾語 使用用途 ◦◦_ms , ◦◦_sec 値の単位を表す Html_utf8 , plaintext_password その他重要な属性を表す 変換処理などで苦戦しないように
30. 2.命名規則 まとめ ・命名規則を使ってよりわかりやすく！ ・意味は明確に具体的に書こう！ ・汎用的なものに気をつけよう！ ・プレフィックスとサフィックスを活用しよう！
31. 過去のCAMP　開発実績 アジェンダ 1. リーダブルコードとは ‐ そもそもリーダブルコードとは ‐ なぜリーダブルコードが必要なのか 2. 命名規則 ‐ 命名規則とは？ ‐ 単語を明確に ‐ ループイテレータ ‐ プレフィックスとサフィックス 3. コメントアウト ‐ コメントすべきでないこと ‐ コメントは簡潔に 4. 演習問題
32. 3.コメントアウト コメントすべきこと、すべきでないこと 何が登録されていたら？ 発信するって具体的には？ そもそもコードで理解できるのでは？
33. 3.コメントアウト コメントすべきこと、すべきでないこと
34. 3.コメントアウト まとめ コメントすべきでは「ない」もの 　・コードから読めること 　・よくないコードを補うコメント コメントは簡潔に ・代名詞は避ける ・動作は具体的に説明する
35. 過去のCAMP　開発実績 アジェンダ 1. リーダブルコードとは ‐ そもそもリーダブルコードとは ‐ なぜリーダブルコードが必要なのか 2. 命名規則 ‐ 命名規則とは？ ‐ 単語を明確に ‐ ループイテレータ ‐ プレフィックスとサフィックス 3. コメントアウト ‐ コメントすべきでないこと ‐ コメントは簡潔に 4. 演習問題