ANSI Cでドキュメントコメントを書く方法は？[閉まっている]

Question

Cでコメントを書く方法が見つかりません。つまり、//と/* */について知っているということです。つまり、どこで良い習慣を見つけることができるのでしょうか。関数がある場合のように、Javaで行われるように、@param variable is the value bla blaをどのように記述しますか？

これに関する基準はありますか？それとも、Javaで行うのと同じように行うことはできますか？

Answer 1

さまざまな標準があります。ドキュメントを生成する場合は、 doxygen を試してください。

Answer 2

会社が義務付けている基準に従う基準はありません。
プロジェクトからドキュメントを作成する一般的な方法は、 doxygen を使用することです。>

Answer 3

javadoc標準を使用してから、javadocを理解する doxygen を使用してドキュメントを生成できます。>

doxygenでは、JAVADOC_AUTOBRIEFに設定されたオプションYESを使用することをお勧めします。JAVADOC_AUTOBRIEFタグがYESに設定されている場合、doxygenはJavadocスタイルのコメントの最初の行（最初のドットまで）を簡単な説明として解釈します。

クラス定義の例： ジェネラコディセタグプレ

（doxygenマニュアルのいくつかの例）

インストールは本当に簡単です。GUIと優れたグラフィカルな視覚化が利用できます： ジェネラコディセタグプレ

doxywizardを呼び出すGUIを実行し、ウィザード設定を使用します。「エキスパート」設定では、JAVADOC_AUTOBRIEFのみを設定する必要があります。

Answer 4

オプションは、コメントを書き込むdoxygen形式を使用することです。これには、コードのhtml / latexやその他の種類のドキュメントを生成できるという追加の利点があります。