javaエンジニアとしてのコメントの作法

プログラム言語は、定められたプログラム言語の仕様にしたがって、コードを作成することになる。また、仕様には定められていない書式についても、守ったほうがいい作法が存在する。たとえプログラムとしては成立したとしても、内容が複雑で理解が難しいコードは、プロのプログラミング技術者として相応しくない。プロのjavaエンジニアとして認められるためには、相応しいコードの書き方をマスターしておくべきである。

プロラムの記述で重要な手掛かりとなるのは、コメントである。ソフトウェア開発では、動作を規定するプログラム部分の記述に加えて、記述者からコメントを随時残す必要がある。
プログラムのコードは、一見してその動作の内容や目的がはっきりと分からないことが多い。コードの記述から内容を理解するとなると、理解に時間や労力がかかる。そこで、プログラムの記述者自身が、どのような機能をコードに持たせているかなどについて、詳しい情報をコメントとして残す。コメントの残し方に明確な規定はないものの、プロのjavaエンジニアが守るべき作法として、コメントを積極的に記述することが望ましい。

コメントの内容もまた、プログラミング技術者としての素質を問われる部分である。理解しやすいコメントが書けるjavaエンジニアは、開発現場で高く評価される。プログラマーとして開発に関わるのであれば、コメントの記述を怠らないよう心がける必要がある。