エンジニアスクールについて
2018年12月18日

ソフトウェア開発におけるコメントの使い方について

ほとんどどのソフトウェア開発で使用されているプログラミング言語は、統合開発環境等が用意されている事が多く、ダンプコードに比較すれば解りやすい高級型プログラミングであると言えます。

そしてプログラミング言語のマニュアル等を見れば、日本語でコメントを入れる機能がある事が解るでしょう。しかし、プログラミング言語が人間に解りやすい状況となっている昨今において、当該のプログラミング言語のスキルを持つものであれば、コメントを入れる必要がない所まで入れるプログラマーがいます。そもそもコメントという機能は、特別に文言で示さなければ理解に苦しむ、あるいは理解が何か特別な事情で書いておかないと混乱する等という場合に、適切に入れるというのが基本的な使い方になるでしょう。

但し、顧客側の提出図書類にソースと、ソース毎にコメントを入れなければならないという要請があれば、いれざるを得ないでしょう。特に派遣社員等でプロジェクトに参加している場合には、従わざるを得ません。スクラッチからソフトウェア開発を行う場合は以上の様な、方向性でコメントを捉える事になるでしょう。そしてもし提出図書の期限に余裕を持って完成していたとすれば、1ステップずつコメントを書く事で問題は解決します。しかし、一番困難なプロジェクトは本番運用されているシステムを現状維持しつつ、ソースコードを見て、顧客からの要望する機能を追加やリニューアル等をする事でしょう。

コメントには第三者が読む事を想定した、明瞭な文言を残すのが一般的であり、それがプロのソフトウェアエンジニアと言えるでしょう。しかし、暗号の様なコメントが書かれていて、ソースコードから読み取る事も出来ず、おまけに設計書が見つからない等という事もあります。その様な場合はプロジェクトリーダー等に相談をして、スクラッチから書いた方が良いか今後の対策を練る事になるでしょう。

Leave a Reply

Your email address will not be published. Required fields are marked *