たかが命名、されど命名

by 44

Slide 1

Slide 1 text

たかが命名、されど命名思いやりのある命名をしよう

Slide 2

Slide 2 text

DDDとの関わり ● 専門学校 3年生「エリック・エヴァンスのドメイン駆動設計」を読む => 分からなくて読むの諦める ● 専門学校 4年生「実践ドメイン駆動設計」を読む => なんとなく分か… 分からなくて読むの諦める

Slide 3

Slide 3 text

命名にどれだけ時間を使ってますか？

Slide 4

Slide 4 text

プログラミングにおける命名 ● クラス名 ● メソッド名 ● 変数名（ローカル・フィールド）

Slide 5

Slide 5 text

命名をこだわらなくても動く

Slide 6

Slide 6 text

なぜ、名前をつけるのか？自分の書いたコードを理解できるようにする為

Slide 7

Slide 7 text

その時の自分だけがわかる命名になりがち

Slide 8

Slide 8 text

なぜ、名前をつけるのか？自分の書いたコードを他の人(未来の自分も含む)にも理解できるようにする為

Slide 9

Slide 9 text

理解が出来ないことで起こること ● 全貌の把握に時間がかかる・把握出来ない ● 変更・削除していいものか判断がつかない ● 機能追加・変更に臆病になってしまう

Slide 10

Slide 10 text

サービスの成長が遅くなる

Slide 11

Slide 11 text

そうならないように良い命名をしよう！

Slide 12

Slide 12 text

良い命名とは？仕様のどの部分を表現しているのかがわかりやすい事 ● 探しやすい => パッケージ構成など ● 理解がしやすい ○ 名前が責務を表す ○ 単語が仕様書に出てくる単語である

Slide 13

Slide 13 text

Slide 14

Slide 14 text

良い命名が出来ない？ ● 仕様がちゃんと理解出来ていない・詳細に定義されていない ● 単語で命名しようとしている一度やりたいことを文章に書き出して整理しよう ● クラスやメソッドが色んな事をしようとしている (多重責務)

Slide 15

Slide 15 text

全てを説明しようと思い長い名前になってしまう

Slide 16

Slide 16 text

長い名前になってしまった時は？ ● 多重責務になってないか改めて考え、責務を分割しよう ● 単語を省略する(おすすめしません) 省略する時は、ルールを決める

Slide 17

Slide 17 text

省略するのではなくスコープを切る適切にスコープを切ることで、長い名前を短くする => 〇〇▲▲☆☆を〇〇の▲▲の☆☆にする ● インナークラス ResultListItem => ResultList.Item ● クラスのフィールドにする userName => user.name

Slide 18

Slide 18 text

名前を考える

Slide 19

Slide 19 text

良い命名をする為の準備 ● プログラミングでよく使われるパターン(デザインパターンなど) を覚えよう BuilderやFactory、Dao、Dto ● 文法をチームで決めておく例) メソッド名は動詞 + 名詞など ● チーム内での単語帳を作っておく

Slide 20

Slide 20 text

つけちゃ駄目な名前 ● 〇〇Manager => 〇〇を管理するクラス ● 〇〇Util => 〇〇を扱う便利メソッドが詰められたクラス上の名前をつけたくなったらHOWを考えて分解しよう ● 〇〇をどう管理するのか？ ● 〇〇をどうやって便利にするのか？

Slide 21

Slide 21 text

良い名前かどうかを判断する方法 ● 他の人にコードを呼んでもらう ○ レビュー ○ 時間をおいてセルフレビュー

Slide 22

Slide 22 text

命名だけでは伝えきれない他の人に伝える方法 ● 命名 ● コメント ● ドキュメント

Slide 23

Slide 23 text

伝えられる情報量命名コメントドキュメント少ない多い

Slide 24

Slide 24 text

コメントやドキュメントの方が良いのでは？

Slide 25

Slide 25 text

伝え方とコードとの距離命名コメントドキュメント近い遠い

Slide 26

Slide 26 text

コードとの距離が遠くなれば、情報の鮮度が落ちるコードを修正した時に情報の更新を忘れられ、コードと情報に差異が生まれる。コメントとコードで言っていること・やっていることが違うという事態に

Slide 27

Slide 27 text

いつ、だれに、どれだけ伝えたいかで伝え方を選択しよう

Slide 28

Slide 28 text

まとめ ● 良い命名をするのは簡単ではないが、適当な命名をすると後悔するかも？ ● 命名だけでは全てを伝えられない、伝える方法にはメリット・デメリットがある ● 良い命名が出来るようになるには、日々訓練するしかない

Slide 29

Slide 29 text

思いやりをもった命名を！