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

Public Repository の OSS や会社の Private Repository などソースコードを読む機会が多々ある。その際に効率よくコードリーディングを行うための Tips を書き残す。

想定読者¶

• VSCode user

Tips¶

codetour を使う¶

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

GitHub Repositories を使う¶

GitHub Repositories は、VSCode の拡張機能で、GitHub のリポジトリを VSCode で開くことができる。git cloneを実行することなく、手元の editor でリポジトリを開くことができる。先にも書いた通り、codetour と組み合わせて使うと、コードリーディングの効率が上がる。