2009-08-19

C++ではコメントをどこに書く?

C++ではヘッダファイルに宣言を書きソースファイルに定義を書く
故に関数の引数とか返値の説明をコメントでつける場所はソースファイルではなくヘッダファイルが正解だと思うのですが…

この意見に賛同してくれる人が意外と少なくて驚きました
発注元に入ってる大手コンサル会社の人までソースファイルに書かないとわからないと言うので
要求に従いソースファイルにコメントをコピーしましたが、なんだかすごく納得いかない
メンバ変数やクラスの説明はヘッダファイルだけどメソッドはヘッダファイルに書かずにソースファイルに書く意味がわからない

1 件のコメント:

匿名 さんのコメント...

C++の現場は最初の1回しかないかつどうだったか忘れてしまったのですが、個人的にはC++言語は好きなので家で使っています。

結局は主観なのですが、ヘッダーファイルの位置づけ(定義するところ)からコメントはヘッダーにあるのがしっくりと思っています。

ソースコードに書くのが主流というのは、もはやきちんと設計するとか再利用なんて考えていないからだと思います(これも主観です)。