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
7
2.1k
「とりあえず動く」コードはよい、「読みやすい」コードはもっとよい / 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
小さく段階的リリースすることで深夜メンテを回避する
mkmk884
2
260
仕様変更に耐えるための"今の"DRY原則を考える
mkmk884
9
3.9k
php.iniって何書いているの
mkmk884
2
620
1人プロ・ペアプロ・モブプロの効果的な使い分け
mkmk884
0
1.6k
テスト嫌いな自分の苦手意識がなくなった話
mkmk884
4
1k
部内全員で理想の開発部を考え、それに向かって1年間継続して活動に取り組む環境をつくった話
mkmk884
0
220
Other Decks in Programming
See All in Programming
『リコリス・リコイル』に学ぶ!! 〜キャリア戦略における計画的偶発性理論と変わる勇気の重要性〜
wanko_it
1
590
コーディングエージェント時代のNeovim
key60228
1
100
20250808_AIAgent勉強会_ClaudeCodeデータ分析の実運用〜競馬を題材に回収率100%の先を目指すメソッドとは〜
kkakeru
0
200
SOCI Index Manifest v2が出たので調べてみた / Introduction to SOCI Index Manifest v2
tkikuc
1
110
DockerからECSへ 〜 AWSの海に出る前に知っておきたいこと 〜
ota1022
5
1.8k
CSC305 Summer Lecture 12
javiergs
PRO
0
110
decksh - a little language for decks
ajstarks
4
21k
The state patternの実践 個人開発で培ったpractice集
miyanokomiya
0
150
Laravel Boost 超入門
fire_arlo
1
120
マイコンでもRustのtestがしたい その2/KernelVM Tokyo 18
tnishinaga
2
2.3k
ライブ配信サービスの インフラのジレンマ -マルチクラウドに至ったワケ-
mirrativ
2
260
ワープロって実は計算機で
pepepper
2
1.4k
Featured
See All Featured
Visualizing Your Data: Incorporating Mongo into Loggly Infrastructure
mongodb
48
9.6k
"I'm Feeling Lucky" - Building Great Search Experiences for Today's Users (#IAC19)
danielanewman
229
22k
The Cost Of JavaScript in 2023
addyosmani
53
8.8k
How To Stay Up To Date on Web Technology
chriscoyier
790
250k
What’s in a name? Adding method to the madness
productmarketing
PRO
23
3.6k
[RailsConf 2023] Rails as a piece of cake
palkan
56
5.8k
The Cult of Friendly URLs
andyhume
79
6.5k
Performance Is Good for Brains [We Love Speed 2024]
tammyeverts
10
1k
Practical Orchestrator
shlominoach
190
11k
Building a Modern Day E-commerce SEO Strategy
aleyda
43
7.5k
BBQ
matthewcrist
89
9.8k
Designing Dashboards & Data Visualisations in Web Apps
destraynor
231
53k
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 • 「とりあえず動く」コードは、価値を提供できるため よい • その後も価値を増大、持続しようとしたときに 「読みやすい」コードが効果を発揮してくる • 変更箇所が多いところからリファクタリングをすると
コスパがいい • 安心してリファクタリングを行うために 意味のあるテストコードが必要
「読みやすい」コードにして 自分にも他者にも 安心を届けていきましょう🙌