コンテンツにスキップ

コードリーディングの効率を上げるための Tips

OSS や社内リポジトリのコードを読むときに、コメントを共有したり、リポジトリを手軽に開いたりできるツールを紹介する。VSCode の codetour と GitHub Repositories を使い、コードを追いやすくする。

想定読者

  • VSCode を使ってコードを読むエンジニア

Tips

codetour と GitHub Repositories という 2 つの拡張機能を紹介する。

codetour を使う

codetourは VSCode の拡張機能で、コードリーディング時にコメントを付けて記録できる。コメントした結果はファイルに出力したり、他の人と共有したりできる。Public Repository でも Private Repository でも利用でき、個人でソースコードの理解を深めるためにも、他の人とソースコードの理解を共有するためにも使える。

codetour でコードにコメントを付けて記録する様子

GitHub Repositories を使う

GitHub Repositoriesは VSCode の拡張機能で、GitHub のリポジトリをgit cloneすることなく VSCode で開けるため、手元の慣れた VSCode 環境でコードリーディングができる。先述の codetour と組み合わせて使うと、コードリーディングの効率が上がる。

ref 指定の制約

GitHub Repositories と codetour を併用する注意点として、ref の設定ができない。ref で branch や tag を指定する機能が codetour にあるが、GitHub Repositories を使うと ref の指定はできず、デフォルトブランチを使うことになる。ref を指定したい場合は、手元にgit cloneして VSCode で開く必要がある。

GitHub Repositories で clone なしにリポジトリを VSCode で開く様子

GitHub Repositories は GitHub Copilot とも組み合わせて使え、Chat 欄の context にファイルを追加したり、インデックスを作成したりできる。実際に使うと、リポジトリを開いたまま Copilot に質問できて便利だった。