他人の目にさらされるということ | エンジニア戦隊ブログマンズ

他人の目にさらされるということ

老師です。

仕事柄、コンピュータのプログラムを作成することがあります。
(年齢のせいか、その頻度は減少傾向ではありますが。)

プログラムというものは元来、正確に動けば良いものですので、「コメント」など書かなくても構わないものでした。
しかし、使っているうちに使いやすいように変更したい場合や、問題がある場合には修正を行いますので、
後から読む場合のためにメモ程度の「コメント」は記入してきたというひとは多いと思います。

作成したプログラムから文書(説明書など)を自動的に作成してくれるツールの存在によって、

「自分さえわかれば良い」

というコメントの書き方では通用しないことが増えてきました。
プログラム中のコメントが「正式文書」としてお客様のもとに届けられてしまう場合がありますので、

「他人が読んだとき、どう思われるか」

にも注意しながら、プログラムを作成しなければなりません。
普段から、他人が読むことを想定したコメントの書き方を意識していれば良いだけのお話なのですけどね。