Cでコメントを書く方法がわかりません。私は//
と/* */
について知っていますが、いい意味でどこでいいのでしょうか?私は関数を持っている場合と同様に、それはJavaで行われているように@param variable is the value bla bla
をどのように書くのですか?ANSI Cのドキュメントコメントを書くには?
これに関する基準はありますか?あるいは、Javaでやっているようにしてもいいですか?あなたはドキュメントを生成したい場合は
Cでコメントを書く方法がわかりません。私は//
と/* */
について知っていますが、いい意味でどこでいいのでしょうか?私は関数を持っている場合と同様に、それはJavaで行われているように@param variable is the value bla bla
をどのように書くのですか?ANSI Cのドキュメントコメントを書くには?
これに関する基準はありますか?あるいは、Javaでやっているようにしてもいいですか?あなたはドキュメントを生成したい場合は
多くの異なる規格がありますが、何の基準はどの会社の義務標準に準拠していないがありますdoxygen
を試してみてください。
プロジェクトからドキュメントを作成する一般的な方法は、Doxygenを使用することです。
オプションは、doxygen形式のコメントを書くことです。これはhtml/latexや他の種類のドキュメントをコードに生成できるという利点があります。
javadoc標準を使用して、doxygenを使用すると、javadocがドキュメントを生成することがわかります。
doxygenでは、JAVADOC_AUTOBRIEF
をYES
に設定することをお勧めします。 JAVADOC_AUTOBRIEFタグがYESに設定されている場合、doxygenはJavadocスタイルのコメントの最初の行(最初のドットまで)を簡単な説明として解釈します。クラス定義のための
例:
apt-get install doxygen doxygen-gui graphviz
:
/**
* A brief description. A more elaborate class description
* @param bool somebool a boolean argument.
* @see Test()
* @return The test results
*/
(いくつかのより多くの例in the doxygen manual)
インストールはGUIとして利用できる素敵なグラフィカルな可視化があり、本当に簡単です
doxywizard
を呼び出すguiを実行し、ウィザード設定を使用してください。JAVADOC_AUTOBRIEF
のみが「エキスパート」設定で設定されていなければなりませんings。
例についての素敵な答え。 – Drew
実際には、ANSI Cでは '//'を使用することもできません。C99からのみ、 '//'を許可しました。 (GCCはこれを拡張子として許していますが) – Mysticial
'/ * * /'のみがCでサポートされています。 '//'はC++での追加です –
"ANSI C"という用語は、通常、1989 ANSI規格厳密に言えば、間違っています。 1990年に、ISOは同じ標準を発行し(いくつかの新しい導入材料と番号のついたセクションとともに)、ANSIがそれを採用しました。 1999年にISOは新しいC標準を発行し、ANSIもそれを採用し、1989/1990標準を正式に廃止しました。 2011年後半に、ISOはANSIが採用しているもう1つの新しいC標準を発行しました。最初のものを除いて、Cの標準はANSIではなくISOによって最初に公開されています。年ごとに標準を参照するのが最善です。 –