Cでコメントを書く方法が見つかりません。つまり、私は知っているということ//です/* */。つまり、どこで良い習慣を見つけることができるのでしょうか。関数がある場合の@param variable is the value bla blaように、Javaで行われるように、どのように記述すればよいですか？
これに関する基準はありますか？それとも、Javaで行うのと同じように行うことができますか？
18415 次
4 に答える
13
多くの異なる標準があります。ドキュメントを生成したい場合は、doxygenを試してください
于 2012-01-17T05:10:15.810 に答える
10
javadoc標準を使用してから、javadocを理解するdoxygenを使用してドキュメントを生成できます。
doxygenでは、にJAVADOC_AUTOBRIEF設定されたオプションを使用することをお勧めしますYES。JAVADOC_AUTOBRIEFタグがYESに設定されている場合、doxygenはJavadocスタイルのコメントの最初の行（最初のドットまで）を簡単な説明として解釈します。
クラス定義の例：
/**
* A brief description. A more elaborate class description
* @param bool somebool a boolean argument.
* @see Test()
* @return The test results
*/
（ doxygenマニュアルのいくつかの例）
インストールは本当に簡単です。GUIと優れたグラフィカルな視覚化が利用できます。
apt-get install doxygen doxygen-gui graphviz
GUI呼び出しdoxywizardを実行し、ウィザード設定を使用しJAVADOC_AUTOBRIEFます。「エキスパート」設定で設定する必要があります。
于 2015-12-22T05:52:54.737 に答える
5
あなたの会社が義務付けている基準に従う基準はありません。
プロジェクトからドキュメントを作成する一般的な方法は、doxygenを使用することです。
于 2012-01-17T05:10:15.787 に答える
3
オプションは、コメントを書き込むdoxygen形式を使用することです。これには、コードのhtml/latexやその他の種類のドキュメントを生成できるという追加の利点があります。
于 2012-01-17T05:12:00.260 に答える