1

テキスト（コードではなく）を条件付けする最良の方法は何でしょう。条件付きでタグ付けしたいドキュメントには 3 つのレベルがあります。 開発者– これは、doxygen にまったく出力させたくないドキュメントです。開発者への注意事項など。 内部– ドキュメントの内部バージョンについてのみ表示される情報。 NDA - お客様向けの情報と、開発者または内部としてタグ付けされていない情報。内部ドキュメントのサブセットであり、たとえば内部 Web サイトを除外します。

4

1 に答える 1

0

これを実現するのに役立つdoxygenコマンドと構成オプションがいくつかあります。これらにはとが含ま\internalれ\endinternalます。doxygenマニュアルから：

\internalこのコマンドは、内部使用のみを目的としたドキュメントフラグメントを開始します。

INTERNAL_DOCS構成ファイルで使用して、内部ドキュメントを表示（ YES）または非表示（ ）することができます。NO

必要なドキュメントの3つのバージョンに対処するには：

  • 開発者：標準のC /C++コメントを使用します/* ... */。これらはdoxygenによって触れられません。

  • 内部：内部使用のみのドキュメントの場合は、doxygenコメント、、を使用し/** ... */、ドキュメントのこれらの部分を\internaland\endinternalコマンドでラップします。ドキュメントを内部で配布する場合は、ドキュメントを作成するときに構成ファイルオプションINTERNAL_DOCSをに設定しますYES。

  • NDA：顧客に見えるドキュメントについては、ドキュメントを作成するときに、doxygenコメントを使用し、構成ファイルで/** ... */構成オプションINTERNAL_DOCSをに設定するだけです。NO

于 2012-09-06T16:54:39.560 に答える