ながれです。
今回は、お仕事のプログラミング第２弾！
前回はコードの可読性の話を中心にお話しました。
前回記事はこちらから。
今回は、前回とは少し視点を変えて、ローカルのソースコード管理方法についてです。
皆さんはどのようにローカルでソースコードを管理していますでしょうか？
私の場合
1 . コード作成中はPC内のローカルフォルダ
2 . ある程度機能実装が完了したらプロジェクト内のサーバ
3 . 全機能実装完了後でテスト前はクライアントのソースコード管理サービス
4 . 不具合修正はローカル(PC内、プロジェクト内サーバ含む)
5 . 4の後の動作確認後に3にアップ
のような管理方法でした。
今回の話は、1,2,4に関わる話です。
要は社内でソースコードを管理している時ですね。
ソースコード管理サービスなどを利用せず、フォルダ内に直接おいてる時に
「あれ、このコードどこまで機能追加したっけ？」
「コード追加したらうまく動かない…でも追加したとこ覚えてない…」
「不具合修正したのに、違う不具合出た…もうどこ直したかわからない…」
なんてことに、ならないような工夫をお話します！
ぜひ最後までご覧ください。
ローカルソースコードの管理方法
工夫は2つ。
・ローカルでバージョン管理する
・READMEを必ず作成する
これだけです。
これで、ソースコードの追加・修正をして何かがあっても、すぐに前の状態に戻すことができます。
ローカルでバージョン管理する
クライアント向けのバージョン管理とは別に、さらに細かくローカルでバージョン管理することです。
例えば、アプリ側のログイン機能作成が完了したら「PJ○○_App_Login」というフォルダを作成して、その中にソースコードを格納します。同様にサーバ側のログイン機能を追加したら「PJ○○_Server_Login」というフォルダを作成して格納します。
さらに、各機能が実装・動作確認完了した段階で、そのソースコードを「ベースソースコード」としておくのが良いでしょう。
機能追加はベースのコピーを作成して追加していけば、ソースコードの差分チェックもしやすいです。
ベースから変更点が少ない場合は、変更したソースファイルのみを格納しても良いでしょう。
このように、ローカルでバージョン管理をすることで機能追加や不具合修正も、混乱することなく可能です。
READMEを必ず作成する
先ほどのローカルでバージョン管理するために、作成したフォルダ内に必ずREADMEを作成しておきましょう。
どの機能がどこまで作成しているのか、どこまで動作確認完了しているのか。
変更したソースコードはどのように変更したのか。
など、自分でわかりやすいメモを必ず残してください。
フォルダ名だけでは、詳細がわからないためREADMEを作成します。
これで、後から見返したときにフォルダごとのソースファイルの状態がわかります。
おわりに
いかがだったでしょうか？
ソースコード管理サービスをローカルでも利用している方には、あまり意味のない情報だったかもしれません。
しかし、ソースコードを直接管理している方は「どれがいつのファイルだっけ？」となること、経験あると思います。
ぜひ上記の方法を用いて、ソースコード管理を行ってみてください！
