Upgrade to Pro — share decks privately, control downloads, hide ads and more …

リーダブルなPHPDocを目指して / Aiming for a readable PHPDoc

Masato Nishihara
July 06, 2021
Technology
0
24

リーダブルなPHPDocを目指して / Aiming for a readable PHPDoc

2021/7/7に開催されたリーダブルコード LT会 - vol.2で発表したスライドです。

Masato Nishihara

July 06, 2021
Tweet

More Decks by Masato Nishihara

See All by Masato Nishihara
ウォーターフォールとアジャイルと楽楽明細/Waterfall×Agile×Rakurakumeisai
whitefox_73
1
420
14年目のサービスと今後も歩むためのリファクタリング戦略
whitefox_73
0
910
正攻法はあるのか!?泥臭く戦ったNode.jsバージョンアップ一部始終
whitefox_73
4
4.5k

Other Decks in Technology

See All in Technology
IIJmio meeting 33 無線通信の世界～第一弾：無線通信とは？～
iij_techlog
1
2.9k
KDD2022参加報告
line_developers
PRO
0
210
Autonomous Database Cloud 技術詳細 / adb-s_technical_detail_jp
oracle4engineer
PRO
10
20k
JaSST Review 22 Introduction / JaSST Review'22 内容紹介
nihonbuson
0
160
【Oracle Cloud ウェビナー】一目瞭然！Microsoft Azureから使える、新しいOracle DatabaseのPaaSサービスを使ってみよう！(2022年9月21日)
oracle4engineer
PRO
0
120
デイリースクラムいらなくなくなくなーい！？
kitamu_mu
17
15k
SNS連動型_サイネージ運用.pdf
bau
0
150
php-srcを読んでみよう / php-src codereading
tzmfreedom
0
450
コミュニティを活用した勉強習慣化.pdf
taketakekaho
1
240
AWS Security Hub導入と運用の検討ポイント
yhana
0
430
Blockchain GIG#13 NFTのユースケースとHyperledger Fabricでの実装
gakumura
0
180
220914_ガンダム初学者が色々考えてみた_株式会社コミュカル Mitz
comucal
PRO
0
340

Featured

See All Featured
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
eileencodes
120
28k
5 minutes of I Can Smell Your CMS
philhawksworth
196
18k
Principles of Awesome APIs and How to Build Them.
keavy
114
15k
BBQ
matthewcrist
74
8k
Automating Front-end Workflow
addyosmani
1351
200k
How to train your dragon (web standard)
notwaldorf
62
4k
10 Git Anti Patterns You Should be Aware of
lemiorhan
642
53k
Java REST API Framework Comparison - PWX 2021
mraible
PRO
12
5k
Six Lessons from altMBA
skipperchong
15
1.5k
How to Ace a Technical Interview
jacobian
268
21k
The Pragmatic Product Professional
lauravandoore
19
3.2k
Design and Strategy: How to Deal with People Who Don’t "Get" Design
morganepeng
109
16k

Transcript

  1. #readablelt ©2021 RAKUS Co., Ltd. リーダブルな PHPDocを目指して 株式会社ラクス 西原 優人

  2. #readablelt 自己紹介 経歴 • 2015年に新卒でラクスに入社 • 「Mail Dealer」や「Chat Dealer」の開発を経 て現在は「配配メール」の開発担当

    良く触る技術 • PHP • JavaScript • Node.js • PostgreSQL 西原　優人 (masato nishihara) Twitter : whiteFox_73 趣味 • アウトドア フットサル／スノーボード／バイク ／ペンギン • インドア 音楽鑑賞／ゲーム／ ペンギン

  3. #readablelt 配配メールとは • メールマーケティングに必要な機能を備えたメール配信サービス • マーケティングオートメーションツールを備えたプランもある • 現在サービス開始から15年目

  4. #readablelt 2月にあったRAKUSMeetUpにて Speaker Deck https://speakerdeck.com/whitefox_73/14nia n-mu-falsesabisutojin-hou-mobu-mutamefal serihuakutaringuzhan-lue logmi Tech https://logmi.jp/tech/articles/323993

    ※テキストで当日の発表内容が紹介されています

  5. #readablelt 今回の内容は またリファクタリングの話になります

  6. #readablelt 今回の内容は プログラムには影響しないけど 重要なコメントPHPDocについてです

  7. #readablelt 今回の内容は PHPDocとはPHPで書かれたのクラスや関数などの ブロックに記述できるDocComment内に記述する書式

  8. #readablelt 今回の内容は 実際のイメージ

  9. #readablelt 今回の内容は PHPDocの書き方に関しては弊社ブログにもまとめています 型を使いこなすためのPHPDocの書き方 https://tech-blog.rakus.co.jp/entry/20210326/php#PHPDo c%E3%81%A8%E3%81%AF 同じチームの後輩が書いてくれました !!

  10. #readablelt 今回の内容は 無法地帯となっていたPHPDocを メンテしましたって話

  11. #readablelt メンテされてないとはどんな状態だった？ 一つ目

  12. #readablelt メンテされてないとはどんな状態だった？ 書いてない…

  13. #readablelt メンテされてないとはどんな状態だった？ 二つ目

  14. #readablelt メンテされてないとはどんな状態だった？ フォーマット違 う…

  15. #readablelt メンテされてないとはどんな状態だった？ 三つ目

  16. #readablelt メンテされてないとはどんな状態だった？ 型違うやん…

  17. #readablelt メンテされてないとはどんな状態だった？ 3つ問題点がありましたが、一番ヤバいのは3つ目 • PHPDocが書かかれている関数と書かれていない関数が混在 • PHPDocの書き方が統一されていない • PHPDocに書かれている内容が正しくない事がある PHPDocは真実と嘘が織り交ざっており、まるで詐欺師状態

  18. #readablelt なんでメンテしようと思ったの？ • チームメンバーの入れ替わりで経験則でカバーできなくなってきた • 生産性を上げる為に、無駄な時間を使いたくなかった • 役に立っていないPHPDocが勿体ない

  19. #readablelt どうやってメンテした？ 3段階でメンテナンスを実施 • PHPDocの修正 ◦ 過去の誤ったPHPDocをあるべき姿に • ルール作成 ◦

    現在進行形で誤った PHPDocが増えないように • ルール定着 ◦ 未来もPHPDocが綺麗に維持できるように

  20. #readablelt どうやってメンテした？ PHPDocの修正 • PHPDocを書く対象の関数は数千個以上… • まずは利用頻度の高い共通関数から対応 • 業務の合間に改善施策として長期的に取り組んで対応

  21. #readablelt どうやってメンテした？ ルール作成 • コーディングルールにPHPDocに関する項目を追加 • ルールをチーム内に展開し、PHPDocの認識を合わせる

  22. #readablelt どうやってメンテした？ ルール定着 • ルール定着の為、PHPDocもコードレビュー対象 • チーム内にも共有しレビューを徹底してもらう

  23. #readablelt 効果はあった？ • コードレビューや調査の際に、PHPDocを信頼できるようになった • IDEの補完が効くようになった • IDEで誤った不要な警告がでなくなった

  24. #readablelt 取り組んでの所感 • 無法地帯だったPHPDocをメンテした • メンテを怠ると正常な状態に戻すのがとても大変 • 信頼できるPHPDocである事が大切 • IDEの恩恵も受けることが出来て良いことばかり

  25. #readablelt サボらずにPHPDocをメンテしましょう