~エンジニアのあんなことこんなこと~

ソースコードコメントから見る、
エンジニアあるある

#トレンド技術ブログ

ソフトウェア開発では、他の開発者が見ても自分の書いたコードがどのような動作をするのかわかるようにするため、コードにコメントを残します。本来コメントには、「APIの仕様」、「クラスの責務」、「そのコードをどう利用すべきか(たとえば、メソッドだったらどんな値を返すのか)」などを書くものです。しかし実際には、本来コードのコメントに書くべきことではないことが書かれることも多々あります。その開発者の性格や思いが前面に出ていておもしろいので、この種のコメントでよくあるものを集めて紹介してみました。本来の使い方をされていないコメントには具体的には、「おまじない」、「疑問」、「願望」、「謝罪」、「文句」、「言い訳」、「Todo」などがあります。もちろんこれ以外のものもあると思いますが、今回はその中でも特によくあるものを挙げています。

 

【1】おまじない

一目見ただけでは何をしているのかよくわからないロジックに、この「おまじない」コメントが書かれています。「このコードの意味は理解しなくていいけど、必要だから消さないでね。」という意味で使われています。

 

【2】疑問

コードを読んだ他の開発者が理解できず「疑問」コメントを残すことがあるようです。

 

【3】願望

追い詰められた開発者の心の声のようなコメントです。

 

【4】謝罪

手抜きのコードになってしまっている箇所にこの「謝罪」コメントが書かれていることがあります。開発期限の関係上、時間をかけられなかった部分で、このようなコメントを見かけることが多かったです。

 

【5】文句

開発者が嫌いなコーディングをしなければならない場合に、この「文句」コメントを書くことがあります。ある機能を実装する際、コーディングのやり方は複数ある場合がほとんどで、その書き方の好みは開発者によって異なります。

 

【6】言い訳

プログラマーでこの「言い訳」コメントを見たことが無い方はいないのではないでしょうか。どのような動作をするのか調べてもわからなかった過去のソースなどに書かれていることが多いです。消すと新たな不具合を引き起こす可能性があるため、泣く泣く消せずにそのままにしているコードはほとんどのソフトウェアのソースにあるのではないでしょうか。

 

【7】Todo

「Todo」コメントは、本来の使い方としてソースのコメントによく書きます。ただ、ちょっと変わったコメントを見つけたので挙げてみました。

 

いかがでしたでしょうか。開発者が書くコードコメントには時にその人間性が出ることがあります。このようなコメントは複数で開発するほとんどのソフトウェアのソースに書かれているものなので、探してみると興味深いと思います。

関連する記事

To top