【プログラミング学習】書いたコードを効率良く見直す方法

こんにちは!CODE CLUB965のKです!

皆さんは書いたコードについて、どのように見直しをしていますか?
そもそも見直しなんてしていない、という人も多いかもしれません。笑

バグになっている箇所はないか
冗長になっているコードはないか
わかり辛い部分はないか

などの観点で、ぜひ書いたコードは見直す習慣を付けて下さい。

とはいえ、1つの機能開発をした場合に、どこからどこまでが今回書いた分のコードか分かりにくく、コードの見直しも難しいですよね。

今回は、コードを効率良く見直す方法を紹介します。

コードを効率良く見直す方法

書いたコードを効率良く見直すには、Githubを使うのが良いです。

Githubは、構成管理ツールのGitを使うためのWebサービスです。
構成管理ツールについては、以前一度記事に書いたので、良ければ読んでみて下さい。

Githubにはプルリクエストという機能があります。

この機能を使って、以前の変更との差分を綺麗に表示させることができます。

例えばこちら、Vue.jsで実際に作成されているプルリクエストです。
https://github.com/vuejs/vue/pull/11599/files

スクリーンショット 2020-08-25 23.10.57

緑色が追加された部分で、赤色が削除された部分です。

以前との差分が非常にわかりやすく表示されています。

本来は他の人にコードをレビューしてもらう機能

Githubのプルリクエストは、本来は自分が書いたコードをチームメンバーの他の人にコードレビューしてもらうための機能です。

他の人に見てもらうための機能なので、行ごとにコメントができるようになっていて、指摘事項を書くことができます。

本来は他の人にコードを見てもらうための機能なのですが、もちろん自分1人で使うこともできます。

自分でプルリクエストを作成して、自分でコードを確認して、気になった部分について自分でコメントを残すことができます。

この機能を使えば、効率良くコードの見直しができるので、コードの改善もしやすくなるはずです。

Githubのプルリクエストの詳しいやり方はこちらの記事が参考になります。
https://qiita.com/samurai_runner/items/7442521bce2d6ac9330b

ぜひ、実践してみて下さい!

それでは、また!

Follow me!