0

質問はC での Doxygen の使用に関連していますが、関数のプロトタイプまたは定義についてコメントしますか? または両方?.

doxygen の書式設定により、.h ファイルからの宣言とそのコメントが最初に表示され、その後に .c ファイルからの定義とそのコメントが続きます。良い。

悲しいかな、html 出力の .c 定義の直前に使用して、「今、実装について説明しています」と視覚的に示すことができる \param[in] や \return[in] のようなパラメータはありますか? 左にボールド体を配置したり、色を変更して視覚的に強調したりすることもできます。明らかな \implements タグはこれを行いません。

生成された doxygen html コードを確認しましたが、明らかに変更すべき css クラスはありません。したがって、おそらくhttp://www.doxygen.nl/manual/commands.htmlのタグを使用する必要があります。他の人は何を使っていますか?

4

1 に答える 1

0

理想的ではありませんが、簡単であるというメリットがあるオプションの 1 つは、\noteコマンドを使用することです。

実装を説明する段落\noteの前に を付けると、出力に緑と黄色のサイドバーが表示されます。CSSで色を変更できます。後続\noteの段落は個別の段落として残りますが、単一の見出しとサイドバーがあります。

欠点は、セクションの見出しが注:であることです。これは、ニーズによっては受け入れられる場合と受け入れられない場合があります。

代わりに使用できます\xrefitem。これにより、テキストをImplementation:に変更できますが、かなり合理的には、別の相互参照ページにもエントリが生成されます。これはおそらく望ましくありません。クロスインデックスを無効にする方法があるかもしれませんが、それについてのマニュアルには何もありません。

内部使用のみのドキュメントを生成していると思います。おそらくテクニカルマニュアルの何らかの形ですか?その場合、「メモ」オプションが最も迅速で簡単な解決策になる可能性があります。

編集\remark:コマンドを見つけました。基本的に\noteはサイドバーがない場合と同じですが、関連する見出しRemarksの方がアプリケーションに適している場合があります。CSS にサイドバーを追加できる可能性があります。

于 2013-11-05T11:36:11.797 に答える