Recommended
More Related Content
Recently uploaded
Featured
Featured (20)
より良いコードを書くための名前付け
- 2. 目次 1. なぜ名前が重要なのか 2. 悪い名前の問題点 3. 良い名前とは 4. 適切な名前とは 5. 正しい名前の書き方 6. 便利なツール 7. まとめ
- 3. 問題 Quiz
- 4. Quiz ソフトウェアシステム（Eclipse）内における 「名前（識別子）」は、ソースコードのうち 約何％を占めている？ ① 30％ ② 50％ ③ 70％ 正解は… ③ https://www.cqse.eu/publications/2005-concise-and-consistent-naming.pdf
- 5. There are only two hard things in Computer Science: cache invalidation and naming things. -- Phil Karlton 「コンピュータサイエンスで難しいことは２つしかない。 キャッシュの無効化と名前付けである」 by 元Netscape開発者 Phil Karlton
- 6. 目次 1. なぜ名前が重要なのか 2. 悪い名前の問題点 3. 良い名前とは 4. 適切な名前とは 5. 正しい名前の書き方 6. 便利なツール 7. まとめ
- 8. 目次 1. なぜ名前が重要なのか 2. 悪い名前の問題点 3. 良い名前とは 4. 適切な名前とは 5. 正しい名前の書き方 6. 便利なツール 7. まとめ
- 9. 悪い名前の問題点 ● 理解が難しい ○ 直感に反する名前、誤った名前は読むときに何を指しているのか、何が起きるのかが分かりにくい ○ 結局中身を見る手間が生じる ○ 時間が経てば忘れるのでまた読み直す ● 勘違いが起こる ○ 名前から推測して使ったメソッドが思わぬ副作用があった場合にバグになる ● 変更が難しい ○ 誤った名前の機能が至る所に使われていた場合、修正が困難（テーブル名とか特に） ○ すでにその名前が使われている場合、別の名前を考えなければならない ● 読みにくい ○ 命名規則がバラバラだったり、スペルミスがあるとスムーズに読めず、脳内の処理に余計なコスト がかかる
- 10. 目次 1. なぜ名前が重要なのか 2. 悪い名前の問題点 3. 良い名前とは 4. 適切な名前とは 5. 正しい名前の書き方 6. 便利なツール 7. まとめ
- 12. 目次 1. なぜ名前が重要なのか 2. 悪い名前の問題点 3. 良い名前とは 4. 適切な名前とは 5. 正しい名前の書き方 6. 便利なツール 7. まとめ
- 13. 適切な名前とは 名前と挙動が一致しているもの ＝ 名前から想像される意味とシステム上の挙動が一致していること 名前：addTodo todoList addTodo(todo) { Todo.add(todo); } class Todo { private _todoList = []; // 略 public add(todo) { this._todoList.push(todo); } } = 名前から想像される意味 システム上の挙動 todo
- 14. 名前と挙動が一致しないパターン 1. 名前の意味と挙動がずれている 2. 名前の意味が狭すぎる 3. 名前の意味が広すぎる 適切な名前とは
- 17. 名前と挙動が一致しないパターン 3. 名前の意味が広すぎる 名前：getPage 適切な名前とは 名前から想像される意味 システム上の挙動 getPage(url) { response = request(‘GET’, url); return response.body; }; > 挙動はインターネットからとる Database page page page internet file system
- 18. 適切な名前とは もうひとつ大事なこと… 極力「シンプル」な名前を付ける 次のうち、命名としてどちらがより良い名前？ ① 完全で長い名前 （refreshContentsAndPurgePremiumUsersCache） ② 不完全で簡潔な名前 （refreshContents） 正解は… ① https://signalvnoise.com/posts/3250-clarity-over-brevity-in-variable-and-method-names
- 21. 目次 1. なぜ名前が重要なのか 2. 悪い名前の問題点 3. 良い名前とは 4. 適切な名前とは 5. 正しい名前の書き方 6. 便利なツール 7. まとめ
- 22. 正しい名前の書き方 1. 文法 2. 語彙（ボキャブラリー） 3. スペリング 4. その他（より読みやすくする工夫）
- 23. 正しい名前の書き方 動詞（何かをする） 1. 文法 ● ルーチン（関数、メソッドなど「一連の処理をまとめたコードのかたまり」） ● 動詞と目的語の順番に気をつける ○ ❌ emailSend()、formSubmit() ● 引数との関係性をはっきりとさせる ○ send(box) : boxを送る ○ sendTo(box) : boxに送る
- 24. 正しい名前の書き方 名詞（何であるか） 1. 文法 ● 説明を加える場合: （形容詞 | 過去分詞 +）名詞（+ 前置詞 + 名詞）の順番 （形容詞 | 過去分詞）+ 名詞 名詞 + 前置詞 + 名詞（動名詞、代名詞など） deletedFile（削除されたファイル） messageForCustomers（顧客用メッセージ） nestedList（ネストになったリスト） distanceFromPageTop（ページ上部からの距離） ※過去分詞とは「～された（状態の）」を表す 紛らわしい言葉に注意！ 例えば clean は形容詞でもあり動詞でもある。紛らわしい場合は文脈にあった別名を考える。 cleanFile → newFile, cleanedFile, blankFile, emptyFile …!
- 25. 正しい名前の書き方 2. 語彙（ボキャブラリー） 自分の知っているだけの単語でもそれなりに通じるが、 より自然で簡潔で間違いにくいものに改良するために必要なのが語彙力。 stop, quit, exit, abort, cancel, suspend, shutDown, kill, break … 「止める」 日本語を介さずにイメージで捉える Google画像検索が意外に使える
- 26. get と fetch の違い 獲得する、もらう、受け取る、手に入れる という意味 get fetch fetch は go and get / bring「行って取ってくる」意 味。目的のものがある場所に行ってそれを持って来 るイメージで、get や bring に「行って」のニュアンス が加わっているようなもの http://park1.wakwak.com/~english/illust/w_fetch.html
- 27. 正しい名前の書き方 3. スペリング ● スペルミスは些細なようで一番やってはいけないミス ○ コード自体の信用を失う ○ 英語圏では履歴書や課題にスペルミスがあった時点で不合格になることもあるらしい ● 頻出単語ほど間違いやすい ○ calendar, forward, receive, tomorrow, recommend, address … ● 単数形と複数形、現在形と過去形の違いなどにも気をつける ○ ❌ childs ⭕ children ○ ❌ sended ⭕ sent ● 怪しいと感じたら面倒くさがらずに調べる癖をつけよう
- 28. 正しい名前の書き方 その他（より読みやすくする工夫） ブール値 ● とにかく大事なのは「確実にブール値だとわかる」名前であること 「saved」 「saveされたかどうか」「セーブされた何か」どちらなのかわからない。 isSaved とするだけで確実にわかる。 ● なんでも is～ をつければいいというものではない ～が存在するか ～が含まれているか ～すべきか ～する必要があるか exists～ contains～ should～ need～ https://qiita.com/yskszk/items/5a7f99c974773f03a82a
- 29. 正しい名前の書き方 ● 単数と複数を分けるときに「s」を付けただけだと分かりにくい場合がある ○ 単数 todoItem 複数 todoItems ○ 同一プロジェクトに混在していると混乱が起きる場合がある ○ todoItems → todoList, todoItemList, todoItemGroup など、 厳密には必要ない言葉をあえて付け加えることで、 差が大きくなり違いが分かりやすくなる こともあ る その他（より読みやすくする工夫） 名前に差をつける
- 30. 目次 1. なぜ名前が重要なのか 2. 悪い名前の問題点 3. 良い名前とは 4. 適切な名前とは 5. 正しい名前の書き方 6. 便利なツール 7. まとめ
- 31. 便利なツール ● 辞書アプリ（Mac純正アプリ） ● 英和、和英、英英など他にもたくさんの種類の辞書を使える ● とにかくサクッと簡単に使える ● Mac 利用者は常に立ち上げておいた方がいい！？ ● schema.org (https://schema.org/) ○ schema.orgとは、Google、Microsoft、Yahoo! の検索エンジン三社が仕様策定に取り組む組織。 schema.orgの仕様通りにHTMLにマークアップする事で、 Google,Yahoo!,Microsoftなどの検索エ ンジンに正確な情報を収集してもらい、ユーザーに最適な検索結果を提供できる ○ 様々な用語（ボキャブラリー）が定義されている ○ 特にデータベースのテーブル名の命名に役に立つ
- 32. 目次 1. なぜ名前が重要なのか 2. 悪い名前の問題点 3. 良い名前とは 4. 適切な名前とは 5. 正しい名前の書き方 6. 便利なツール 7. まとめ
- 33. まとめ ● 良い名前は、理解しやすく、変更に強く、読みやすい ○ 理想は名前だけを追ってシステムを理解できること （細かい処理内容まで追わなくて理解できること） ● 名前付けの原則は 「名前から想像される意味」と「システム上の挙動」を一致させること ● スペルミスは一番やってはいけないミス ● 語彙力をつけるとよりスマートに、分かりやすい名前をつけられる ○ かといって高度すぎたり難しすぎる言葉は逆に分かりにくくなるのでバランスが大事 ● 常に読み手を意識して、誤解を招くような名前を避ける
- 34. おわり ありがとうございました 参考資料 ● WEB+DB PRESS Vol.110 名前付け大全 ● 真偽値を返す関数のネーミング- Qiita ● 英語の単数形・複数形について