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
「とりあえず動く」コードはよい、「読みやすい」コードはもっとよい / Code that 'j...
Search
Maki Hayashi
December 22, 2024
Programming
6
1.6k
「とりあえず動く」コードはよい、「読みやすい」コードはもっとよい / Code that 'just works' is good, but code that is 'readable' is even better.
PHP Conference Japan 2024のLT登壇資料です。
Maki Hayashi
December 22, 2024
Tweet
Share
More Decks by Maki Hayashi
See All by Maki Hayashi
仕様変更に耐えるための"今の"DRY原則を考える / Rethinking the "Don't repeat yourself" for resilience to specification changes
mkmk884
0
110
php.iniって何書いているの
mkmk884
1
460
1人プロ・ペアプロ・モブプロの効果的な使い分け
mkmk884
0
1.3k
テスト嫌いな自分の苦手意識がなくなった話
mkmk884
3
810
部内全員で理想の開発部を考え、それに向かって1年間継続して活動に取り組む環境をつくった話
mkmk884
0
170
Other Decks in Programming
See All in Programming
Rails アプリ地図考 Flush Cut
makicamel
1
120
『GO』アプリ データ基盤のログ収集システムコスト削減
mot_techtalk
0
120
定理証明プラットフォーム lapisla.net
abap34
1
1.8k
Writing documentation can be fun with plugin system
okuramasafumi
0
120
パスキーのすべて ── 導入・UX設計・実装の紹介 / 20250213 パスキー開発者の集い
kuralab
3
780
sappoRo.R #12 初心者セッション
kosugitti
0
250
Spring gRPC について / About Spring gRPC
mackey0225
0
220
動作確認やテストで漏れがちな観点3選
starfish719
6
1k
責務と認知負荷を整える! 抽象レベルを意識した関心の分離
yahiru
0
190
第3回 Snowflake 中部ユーザ会- dbt × Snowflake ハンズオン
hoto17296
4
370
JavaScriptツール群「UnJS」を5分で一気に駆け巡る!
k1tikurisu
9
1.8k
CI改善もDatadogとともに
taumu
0
110
Featured
See All Featured
The Art of Programming - Codeland 2020
erikaheidi
53
13k
Cheating the UX When There Is Nothing More to Optimize - PixelPioneers
stephaniewalter
280
13k
Exploring the Power of Turbo Streams & Action Cable | RailsConf2023
kevinliebholz
30
4.6k
Docker and Python
trallard
44
3.3k
Making Projects Easy
brettharned
116
6k
Typedesign – Prime Four
hannesfritz
40
2.5k
For a Future-Friendly Web
brad_frost
176
9.5k
Fantastic passwords and where to find them - at NoRuKo
philnash
51
3k
Fontdeck: Realign not Redesign
paulrobertlloyd
83
5.4k
Let's Do A Bunch of Simple Stuff to Make Websites Faster
chriscoyier
507
140k
What's in a price? How to price your products and services
michaelherold
244
12k
Put a Button on it: Removing Barriers to Going Fast.
kastner
60
3.7k
Transcript
「とりあえず動く」コードはよい、 「読みやすい」コードはもっとよい まきまき 2024/12/22 PHPカンファレンス2024 1
まきまき @_mkmk884 愛媛 → 京都 → 小田原 NE株式会社 アプリケーションエンジニア
PHPカンファレンス小田原 コアスタッフ 2
新卒1〜2年目の頃…
最初は「とりあえず動く」コードを書いていた 4 🔰 ぴちぴちの私 実力がない 納期やばい 設計ワカラン ドメイン知識ない テスト…? 💦
チーム? 自分で手一杯だけど?
最初は「とりあえず動く」コードを書いていた 5 🔰 頼む… 💧 ぴちぴちの私 動いて くれ…
最初は「とりあえず動く」コードを書いていた 6 🙏 頼む… 💧 ぴちぴちの私 動いて くれ… 祈り駆動開発
「とりあえず動く」コード 7 • 要件通りに動いている • 開発者が”完全に理解”をしている • テストコードがなかったり、あっても見たいものを 正しくテストできていなかったりする
「とりあえず動く」コード 8 ユーザーに提供したい価値が届く • 要件通りに動いている よい✌
年月は経ち…
「読みやすい」コードに救われ、意識しはじめた 10 どこに追加すれば いいかわかる 大体どの辺りに 書いてありそうか わかる 意図がわかる !
「読みやすい」コード 11 • 誰が読んでも読む時間が短縮される • シンプル • 振る舞いの単位で処理がまとめられている • 適度にコメントがある
• 関数名・変数名で意図がわかる • IDEが認知しやすいコード (コードジャンプができる、Docコメントがある等) コードジャンプできない例:動的にインスタンス化を行っている
「読みやすい」コード 12 • 誰が読んでも読む時間が短縮される • シンプル • 振る舞いの単位で処理がまとめられている • 適度にコメントがある
• 関数名・変数名で意図がわかる • IDEが認知しやすいコード (コードジャンプができる、Docコメントがある等) コードジャンプできない例:動的にインスタンス化を行っている
(余談)コードジャンプができない例 32 <?php // ディレクトリからファイル一覧を取得 $files = scandir('classes'); // .phpを除外してクラス名リストを作成
$classNames = array_filter( array_map( function ( $file) { return preg_replace( '/\.php$/', '', $file); }, $files ), ); // クラスのインスタンス化 $instances = []; foreach ($classNames as $className) { if (!class_exists( $className)) { return; } $instances[] = new $className(); } インスタンス化するクラス名 を動的に作っている (たぶん昔はよくあった) 例
「読みやすい」コード 13 • 誰が読んでも読む時間が短縮される 変更箇所・影響範囲がパッとわかる 変更が早くでき、変更に強いものになる もっとよい✌
「とりあえず動く」コードと「読みやすい」コード 14 「とりあえず動く」コード 「読みやすい」コード 早く価値を増大できる 仕様変更があっても 価値を持続できる 価値を提供すること ができる
• コードを理解しやすくなる 「読みやすい」コードが他者に与える影響 15 → 工数が短縮される → バグに気づきやすくなる → 学習コストを削減できる
• 変更範囲や影響範囲を把握しやすくなり、 見積もりもしやすくなる
• コードを理解しやすくなる 「読みやすい」コードが他者に与える影響 16 → 工数が短縮される → バグに気づきやすくなる → 学習コストを削減できる
• 変更範囲や影響範囲を把握しやすくなり、 見積もりもしやすくなる 安 心
「とりあえず動く」→「読みやすい」 にすればもっともっとよい💪
リファクタリング やっていき!
知識・経験を積むごとに力がつき…
リファクタリングが楽しくなってきた 20 “完全に理解した” の私 はまっていく感じ パズルみたい めちゃくちゃ 勉強になる あの本に書いて あったことを
適用してみよう ♪
リファクタリングが自分に与える影響 21 • 仕様を把握することができる • バグの発生率が下がるため、安心して開発できる • 設計力やコーディングスキルが向上する → 向上する実感も得られる
リファクタリングが自分に与える影響 22 • 仕様を把握することができる • バグの発生率が下がるため、安心して開発できる • 設計力やコーディングスキルが向上する → 向上する実感も得られる
本や他者から学んだ 知識を自分も 実践できる…!
せっかくリファクタリングするなら コスパよく着実に変更していきたい!
リファクタリングをする場所 24 • 拡張することが確定しているところ ◦ チーム開発で別のメンバーが触る等 • コミットが多いところ ◦ つまり、変更・バグがよく発生するところ
◦ 逆にいうと「とりあえず動く」コードも長い期間変更 がなければ、そのままで十分 • テストがしっかり書けている・書かれているところ
リファクタリングをする場所 25 • 拡張することが確定しているところ ◦ チーム開発で別のメンバーが触る等 • コミットが多いところ ◦ つまり、変更・バグがよく発生するところ
◦ 逆にいうと「とりあえず動く」コードも長い期間変更 がなければ、そのままで十分 • テストがしっかり書けている・書かれているところ
リファクタリング自体も 安心して行いたい
不安の壁 27 正しく動くかどうかがわからないまま変更するのは不安 完成の状態(結果・仕様)がわからないと 何をしていけばいいのかもわからない ? 改善後も 正しく動いている から大丈夫だよ ↑
誰かに言ってほしいですよね? 👀
「意味のあるテストコード」が安心をもたらす 28 改善後も 正しく動いている から大丈夫だよ さまざまな制約が「きれいな」どころか「動作する」の前にも立ちふさがる。 私たちは、不安を抱えて考え込んでしまうのをやめにして、代わりに自動化 されたテストによって開発を推し進める。 テスト駆動開発 まえがき
「意味のあるテストコード」が安心をもたらす 29 ここでいう 意味のあるテストコード = 信頼ができるテストコード • エッジケースや異常系も カバーしている •
実装の細部に依存せずに、 振る舞いをテストしている
まとめ 30 • 「とりあえず動く」コードは、価値を提供できるため よい • その後も価値を増大、持続しようとしたときに 「読みやすい」コードが効果を発揮してくる • 変更箇所が多いところからリファクタリングをすると
コスパがいい • 安心してリファクタリングを行うために 意味のあるテストコードが必要
「読みやすい」コードにして 自分にも他者にも 安心を届けていきましょう🙌