「気になったらOSSのコード＋αを読んでいる」という自分になる

この記事は「ひとりでカンファレンスふりかえりo0h Advent Calendar 2021」のday-6です。

ひとりでカンファレンスふりかえりo0h Advent Calendar 2021 - Adventar

今日振り返るのは、「気になったらOSSのコード＋αを読んでいる」という自分になる」です。 PHPerKaigi 2021のレギュラートーク（20分）、PHP Conference Japan 2021のRegular session (25 mins)に応募しました。

概要

自分はCakePHPに対して昔から愛着を持って使っていたり、過去にComposerのコードリーディングを題材としたカンファレンス登壇をしていたりと、なにかと「ソースコードを読むのって楽しいな」という経験をしています。

コードを読めると何かと利点があるように感じています。「お勉強として読む」という場面もあったりします。例えば「ここの処理って、例外が来たときとかどうしているんだろう？」といった具体的なものから、「こういう構造が必要そうだけどクラスの設計ってどうしてるかなー？」といったものもあったり。あるいは、「自分が使っているライブラリ」だけでなくても、GitHub上で「どういう命名してるかな・・・・こういう関数名って使っているものある？」といった観点で、コード検索をしたりなど。

しかし、もっと多いのは「ドキュメント代わり」に使う場面な気もします。「使っているライブラリやフレームワークの処理がどうなるかわからん、ドキュメント見たりググったりするの面倒くさいな、よしメソッド名でコード検索かけて処理追ってみよう！」というものです。

これによって、かなり開発効率は上がった気がするのです。ドキュメントが必ずしも自分の欲しい情報を欲しい角度で扱っているとは限りませんし、Google検索だったりGitHub IssueでもStackoverflowでもzennでもQitaでも・・やっぱり「たどり着くコスト」がどんなものかは、情報を手に入れるまでわかりません。まして「ググって出てきた情報」の正しさは不確かだったりもします。

というわけで、「中身を読んで見る」のはとてもおすすめですし、その行為にハードルを感じられないで入れたらHappyになれるぞ☆とも思うのです。

しかし、慣れてくるまでは何となく億劫で面倒くさい・・ハードルが高く感じられるものでしょう。そこで、このセッションでは「どういう時に読む(読める)といいか」「どうやって楽に読むか」を紹介できれば、と思いました。

具体的には以下のtipsのようなものを含みます。

IDEを使ってコードを検索する
コードジャンプを使って素早く核心にたどり着く
ステップ実行を使えば「当てずっぽう」すら乗り越えて未知のコードにダイブできる
テストコードも読んでおきたいですね！

主にPhpStorm、GitHubを利用して「手軽で気軽に素早く紐解く」ためのヒントを提供できればなーと思います。あと、対象としてはComposerを使うつもりでした(ペチコンの時点で)