【プログラミングの考え方】プログラムにコメントを残そう

自己紹介

TANAKA SYUHEI

IT業界10年目のシステムエンジニアです。

IT系中堅企業→大手企業→大手企業と転職を繰り返し、現在はフリーランスのシステムエンジニアとして活動中です。

システムエンジニア未経験者の講師もしています。

自分がIT業界に未経験で入った時、こんなことを知っていたら良かったな的な情報を掲載します。

これからエンジニアやフリーランスを目指す人に役立てば幸いです。


目次

・なぜ、プログラムにコメントを残すのか?

・どのようにコメントを残すのか?

・後で思い出せるようにコメントしておこう


なぜ、プログラムにコメントを残すのか?

check

プログラムの処理を後で思い出せる様にするためです。

システム開発では、フェーズ(要件定義→設計→実装→テスト→リリースの一連)単位でプログラミングを行います。

そのため、次フェーズで実装する時に、自分で作成したプログラムの処理を忘れてしまうことがあります。

ここで、コメントが残っていると、処理の内容を思い出しやすくなります。


どのようにコメントを残すのか?

check

基本的に、PJのコーディング規約(プログラミングのルール)に沿ってコメントします。

コーディング規約は、主に

・実装した日

・担当者の名前

・処理の説明文

を記載するように定義しています。

PJによっては、コーディング規約がない場合もあります。

このような場合は、後で自分が思い出せるようにコメントをしておくと良いです。


後で思い出せるようにコメントしておこう

check

プログラムは、後任担当者でも理解できる様にコメントしましょう。

PJのメンバーは入れ替えが多く、プログラムを改修する人もフェーズによって変わる場合もあります。

前任の担当者がしっかりコメントを残せば、後任の担当者がすんなりとプログラミングできます。

現在プログラミングをしている人は、後任担当者のことを考えて、丁寧にコメントを残しましょう。