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.1k
React(Kotlin)でToDoアプリを作ってみた
44x1carbon
2
1.7k
Multiplatform Kotlin
44x1carbon
0
170
Other Decks in Technology
See All in Technology
生成AI “再”入門 2025年春@WIRED TUESDAY EDITOR'S LOUNGE
kajikent
0
100
アジャイルな開発チームでテスト戦略の話は誰がする? / Who Talks About Test Strategy?
ak1210
1
580
OSS構成管理ツールCMDBuildを使ったAWSリソース管理の自動化
satorufunai
0
640
RayでPHPのデバッグをちょっと快適にする
muno92
PRO
0
190
大規模アジャイルフレームワークから学ぶエンジニアマネジメントの本質
staka121
PRO
3
1.2k
クラウド食堂とは?
hiyanger
0
110
Visualize, Visualize, Visualize and rclone
tomoaki0705
9
83k
Apache Iceberg Case Study in LY Corporation
lycorptech_jp
PRO
0
320
ディスプレイ広告(Yahoo!広告・LINE広告)におけるバックエンド開発
lycorptech_jp
PRO
0
360
AWSを活用したIoTにおけるセキュリティ対策のご紹介
kwskyk
0
350
4th place solution Eedi - Mining Misconceptions in Mathematics
rist
0
140
ウォンテッドリーのデータパイプラインを支える ETL のための analytics, rds-exporter / analytics, rds-exporter for ETL to support Wantedly's data pipeline
unblee
0
130
Featured
See All Featured
実際に使うSQLの書き方 徹底解説 / pgcon21j-tutorial
soudai
175
52k
Designing Dashboards & Data Visualisations in Web Apps
destraynor
231
53k
StorybookのUI Testing Handbookを読んだ
zakiyama
28
5.5k
Why Our Code Smells
bkeepers
PRO
336
57k
Become a Pro
speakerdeck
PRO
26
5.2k
No one is an island. Learnings from fostering a developers community.
thoeni
21
3.1k
I Don’t Have Time: Getting Over the Fear to Launch Your Podcast
jcasabona
32
2.1k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
7
640
10 Git Anti Patterns You Should be Aware of
lemiorhan
PRO
656
59k
Making the Leap to Tech Lead
cromwellryan
133
9.1k
[Rails World 2023 - Day 1 Closing Keynote] - The Magic of Rails
eileencodes
33
2.1k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
356
29k
Transcript
たかが命名、されど命名 思いやりのある命名をしよう
DDDとの関わり • 専門学校 3年生 「エリック・エヴァンスのドメイン駆動設計 」を読む => 分からなくて読むの諦める • 専門学校
4年生 「実践ドメイン駆動設計」を読む => なんとなく分か… 分からなくて読むの諦める
命名にどれだけ時間を 使ってますか?
プログラミングにおける命名 • クラス名 • メソッド名 • 変数名(ローカル・フィールド)
命名をこだわらなくても動く
なぜ、名前をつけるのか? 自分の書いたコードを理解できるようにする為
その時の自分だけがわかる 命名になりがち
なぜ、名前をつけるのか? 自分の書いたコードを他の人(未来の自分も含む)にも理解できる ようにする為
理解が出来ないことで起こること • 全貌の把握に時間がかかる・把握出来ない • 変更・削除していいものか判断がつかない • 機能追加・変更に臆病になってしまう
サービスの成長が遅くなる
そうならないように 良い命名をしよう!
良い命名とは? 仕様のどの部分を表現しているのかがわかりやすい事 • 探しやすい => パッケージ構成など • 理解がしやすい ◦ 名前が責務を表す
◦ 単語が仕様書に出てくる単語である
良い命名とは? 仕様のどの部分を表現しているのかがわかりやすい事 • 探しやすい => パッケージ構成など • 理解がしやすい ◦ 名前が責務を表す
◦ 単語が仕様書に出てくる単語である
良い命名が出来ない? • 仕様がちゃんと理解出来ていない・詳細に定義されていない • 単語で命名しようとしている 一度やりたいことを文章に書き出して整理しよう • クラスやメソッドが色んな事をしようとしている (多重責務)
全てを説明しようと思い 長い名前になってしまう
長い名前になってしまった時は? • 多重責務になってないか改めて考え、責務を分割しよう • 単語を省略する(おすすめしません) 省略する時は、ルールを決める
省略するのではなくスコープを切る 適切にスコープを切ることで、長い名前を短くする => 〇〇▲▲☆☆を〇〇の▲▲の☆☆にする • インナークラス ResultListItem => ResultList.Item •
クラスのフィールドにする userName => user.name
名前を考える
良い命名をする為の準備 • プログラミングでよく使われるパターン(デザインパターンなど) を覚えよう BuilderやFactory、Dao、Dto • 文法をチームで決めておく 例) メソッド名は 動詞
+ 名詞 など • チーム内での単語帳を作っておく
つけちゃ駄目な名前 • 〇〇Manager => 〇〇を管理するクラス • 〇〇Util => 〇〇を扱う便利メソッドが詰められたクラス 上の名前をつけたくなったらHOWを考えて分解しよう
• 〇〇をどう管理するのか? • 〇〇をどうやって便利にするのか?
良い名前かどうかを判断する方法 • 他の人にコードを呼んでもらう ◦ レビュー ◦ 時間をおいてセルフレビュー
命名だけでは伝えきれない 他の人に伝える方法 • 命名 • コメント • ドキュメント
伝えられる情報量 命名 コメント ドキュメント 少ない 多い
コメントやドキュメントの方が良いのでは?
伝え方とコードとの距離 命名 コメント ドキュメント 近い 遠い
コードとの距離が遠くなれば、情報の鮮度が落ちる コードを修正した時に情報の更新を忘れられ、コードと情報に差 異が生まれる。 コメントとコードで言っていること・やっていることが違うという事態 に
いつ、だれに、どれだけ伝えたいかで 伝え方を選択しよう
まとめ • 良い命名をするのは簡単ではないが、適当な命名をすると後 悔するかも? • 命名だけでは全てを伝えられない、伝える方法にはメリット・デ メリットがある • 良い命名が出来るようになるには、日々訓練するしかない
思いやりをもった命名を!