0

doxygen コメントの特定の部分を 1 つまたは複数のファイルからマークダウン ページにコピーする方法があるかどうかを知りたいです。以下に、私がやろうとしていることを説明します。

いくつかのモジュールで構成される C++ プラグイン コードの開発に取り組んでいます。各モジュールは、そのバージョン番号付けスキームに従います。すべてのプラグイン リリースで、各モジュールの特定のバージョン番号を選択します。エンド ユーザーがこの情報にプログラムでアクセスできるようにするために、namespace次のように設定しました。

namespace VersionInfo {
    string getModuleA_Version() { return "2.3"; }
    string getModuleB_Version() { return "1.0"; }
    string getPlugin_Version() { return "10.11"; }
}

また、この情報をマークダウン ファイルに表示したいと考えていREADME.mdます。README.mdこれは doxygen で可能ですか? もしそうなら、上記の C++ コードとファイルにどのようにコメントすればよいですか?

C++ のコメントにバージョン番号を再度記載する必要がある場合は、問題ありません。例えば：

// Sample pseudo-code
/**
  * @brief version number for module A.
  * @version_moduleA 2.3
  */
string getModuleA_Version() { return "2.3"; }

上記のようにカスタム変数を定義して、マークダウン ファイルで参照することはできますか? たとえば、次のようなものです。

// Sample pseudo-markdown
Versions
- ModuleA : @version_moduleA
- ModuleB : @version_moduleB
- ModuleC : @version_moduleC

doxygen ホームページのドキュメントを調べてみましたが、わかりませんでした。

doxygen コマンドを指摘していただけると助かります。そこから解決しようと思います。

以下の@Zaneのコメントを編集すると、それについてもっと考えさせられました。上記のような解決策が望ましいですが、マークダウン ファイルから対応するコメントにリンクするだけでも問題ないと思います。

4

1 に答える 1

0

ソース コードのコメントをマークダウン ファイルに挿入するという同じ問題を解決する必要があります。私の計画は、doxygen が xml を出力し、独自のカスタム タグをマークダウン ファイル ( @xml_brief_description など) に入れることです。次に、XML ファイルを解析し、マークダウン ファイルで適切な置換を行う後処理スクリプトを記述します。

誰かがこれを達成するためのより簡単な方法を持っているなら、私はすべての耳です.

于 2013-10-18T00:21:07.217 に答える