Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
たかが命名、されど命名
Search
44
April 04, 2019
Technology
2
1.1k
たかが命名、されど命名
44
April 04, 2019
Tweet
Share
More Decks by 44
See All by 44
Kotlin MultiPlatform Projectのロマンを語る
44x1carbon
0
480
Vue.jsで考えるMVVM
44x1carbon
0
2.2k
React(Kotlin)でToDoアプリを作ってみた
44x1carbon
2
1.7k
Multiplatform Kotlin
44x1carbon
0
180
Other Decks in Technology
See All in Technology
[CATS]Amazon Bedrock GenUハンズオン座学資料 #2 GenU環境でRAGを体験してみよう
tsukuboshi
0
150
LINE Notify互換のボットを作った話
kenichirokimura
0
180
caching_sha2_passwordのはなし
boro1234
0
220
どっちの API SHOW?SharePoint 開発における SharePoint REST API Microsoft Graph API の違い / Which API show? Differences between Microsoft Graph API and SharePoint REST API
karamem0
0
110
SSH公開鍵認証による接続 / Connecting with SSH Public Key Authentication
kaityo256
PRO
2
230
モノリスの認知負荷に立ち向かう、コードの所有者という思想と現実
kzkmaeda
0
110
AIエージェント完全に理解した
segavvy
4
290
Amazon EKS Auto ModeでKubernetesの運用をシンプルにする
sshota0809
0
120
Proxmox VE超入門 〜 無料で作れるご自宅仮想化プラットフォームブックマークする
devops_vtj
0
180
「ラベルにとらわれない」エンジニアでいること/Be an engineer beyond labels
kaonavi
0
170
製造業の会計システムをDDDで開発した話
caddi_eng
3
990
アプリケーション固有の「ロジックの脆弱性」を防ぐ開発者のためのセキュリティ観点
flatt_security
34
13k
Featured
See All Featured
Building a Scalable Design System with Sketch
lauravandoore
462
33k
A designer walks into a library…
pauljervisheath
205
24k
GraphQLとの向き合い方2022年版
quramy
45
14k
Git: the NoSQL Database
bkeepers
PRO
429
65k
Understanding Cognitive Biases in Performance Measurement
bluesmoon
28
1.6k
Keith and Marios Guide to Fast Websites
keithpitt
411
22k
How to Ace a Technical Interview
jacobian
276
23k
The Art of Programming - Codeland 2020
erikaheidi
53
13k
Rebuilding a faster, lazier Slack
samanthasiow
80
8.9k
Adopting Sorbet at Scale
ufuk
75
9.3k
Learning to Love Humans: Emotional Interface Design
aarron
273
40k
CoffeeScript is Beautiful & I Never Want to Write Plain JavaScript Again
sstephenson
160
15k
Transcript
たかが命名、されど命名 思いやりのある命名をしよう
DDDとの関わり • 専門学校 3年生 「エリック・エヴァンスのドメイン駆動設計 」を読む => 分からなくて読むの諦める • 専門学校
4年生 「実践ドメイン駆動設計」を読む => なんとなく分か… 分からなくて読むの諦める
命名にどれだけ時間を 使ってますか?
プログラミングにおける命名 • クラス名 • メソッド名 • 変数名(ローカル・フィールド)
命名をこだわらなくても動く
なぜ、名前をつけるのか? 自分の書いたコードを理解できるようにする為
その時の自分だけがわかる 命名になりがち
なぜ、名前をつけるのか? 自分の書いたコードを他の人(未来の自分も含む)にも理解できる ようにする為
理解が出来ないことで起こること • 全貌の把握に時間がかかる・把握出来ない • 変更・削除していいものか判断がつかない • 機能追加・変更に臆病になってしまう
サービスの成長が遅くなる
そうならないように 良い命名をしよう!
良い命名とは? 仕様のどの部分を表現しているのかがわかりやすい事 • 探しやすい => パッケージ構成など • 理解がしやすい ◦ 名前が責務を表す
◦ 単語が仕様書に出てくる単語である
良い命名とは? 仕様のどの部分を表現しているのかがわかりやすい事 • 探しやすい => パッケージ構成など • 理解がしやすい ◦ 名前が責務を表す
◦ 単語が仕様書に出てくる単語である
良い命名が出来ない? • 仕様がちゃんと理解出来ていない・詳細に定義されていない • 単語で命名しようとしている 一度やりたいことを文章に書き出して整理しよう • クラスやメソッドが色んな事をしようとしている (多重責務)
全てを説明しようと思い 長い名前になってしまう
長い名前になってしまった時は? • 多重責務になってないか改めて考え、責務を分割しよう • 単語を省略する(おすすめしません) 省略する時は、ルールを決める
省略するのではなくスコープを切る 適切にスコープを切ることで、長い名前を短くする => 〇〇▲▲☆☆を〇〇の▲▲の☆☆にする • インナークラス ResultListItem => ResultList.Item •
クラスのフィールドにする userName => user.name
名前を考える
良い命名をする為の準備 • プログラミングでよく使われるパターン(デザインパターンなど) を覚えよう BuilderやFactory、Dao、Dto • 文法をチームで決めておく 例) メソッド名は 動詞
+ 名詞 など • チーム内での単語帳を作っておく
つけちゃ駄目な名前 • 〇〇Manager => 〇〇を管理するクラス • 〇〇Util => 〇〇を扱う便利メソッドが詰められたクラス 上の名前をつけたくなったらHOWを考えて分解しよう
• 〇〇をどう管理するのか? • 〇〇をどうやって便利にするのか?
良い名前かどうかを判断する方法 • 他の人にコードを呼んでもらう ◦ レビュー ◦ 時間をおいてセルフレビュー
命名だけでは伝えきれない 他の人に伝える方法 • 命名 • コメント • ドキュメント
伝えられる情報量 命名 コメント ドキュメント 少ない 多い
コメントやドキュメントの方が良いのでは?
伝え方とコードとの距離 命名 コメント ドキュメント 近い 遠い
コードとの距離が遠くなれば、情報の鮮度が落ちる コードを修正した時に情報の更新を忘れられ、コードと情報に差 異が生まれる。 コメントとコードで言っていること・やっていることが違うという事態 に
いつ、だれに、どれだけ伝えたいかで 伝え方を選択しよう
まとめ • 良い命名をするのは簡単ではないが、適当な命名をすると後 悔するかも? • 命名だけでは全てを伝えられない、伝える方法にはメリット・デ メリットがある • 良い命名が出来るようになるには、日々訓練するしかない
思いやりをもった命名を!