私はC++プログラムにコメントを追加しています。あなたがアスタリスクの隣に上記のコメントを書くとき、あなたがこのようにそれらに名前を付けるC++でのコメント
string House:: getName(int &size){
return name;
}
Javaでは：
/*
* @param size It passes the number of rooms.
@return name. It returns name of the house
*/
Cでこれを行うのフォーマットは何ですか++ のは、我々はこのような何かを持っているとしましょうか？
Visual Studioを使用している場合は、hereがコメントのドキュメントの仕様です。
Javadocを参照しています。同じエディタと外部ツールを使用して、同じスタイルのコメントをC++で使用できます。
コメントドキュメントのためのC++「標準」はありません。
+1、すなわちdoxygen。 –
井戸、ツールは+0.5、コメントはメタデータの埋め込みだけでなく、自由形式のコメントも自由形式のままでなければならないという事実を示す+0.5 –
具体的なルールはありません。コメントはコメントであり、無視されて破棄されるので、好きなように形を整えることができます。
コメントを解釈するプログラムdoxygenを使用する場合は、そのプログラムの参照を参照する必要があります。
コードから文書を抽出する場合は、適切なコメント形式に従う必要があります。たとえば、DOxygenを使用するので、Doxygenルールに従わなければなりません。
ドキュメントのコメントを抽出しない場合は、簡単なコーディング方法が適用されます。
javadocと似たドキュメント生成をお探しですか？ – zdan
私は、どのように文書C++コードを作成するかに関する規則があると思いました。それは、私があなたにJavaコードの例を与えたようなものです。 – ucas
もう一つのオプションは、 'size'の代わりに' number_of_rooms'をパラメータ名として使うことです。それが何であるか説明することからあなたを救います。 –