22

GithubでオープンソースプロジェクトのAPIドキュメントを生成したいと思います。C＃プロジェクトのXMLドキュメントコメントから自動的に作成したいと思います。私の弱いグーグルはバブキスになりました。これを行う方法はありますか？

GithubスタイルのMarkdownであることが望ましいです。

4

4 に答える 4

8

オンラインのC# XML ドキュメントから Markdown へのコンバーターは次のとおりです: http://varus.io/vsdoc-2-md/

@formixian のアルゴリズムに基づいています。

于 2016-05-25T17:10:41.207 に答える
7

少し調べてみたところ、この要点の宝石を見つけました。

VS XML ドキュメント ファイルから Markdown を生成します

C# XML -> マークダウンをコンソールに出力します。さらに洗練される可能性はあると思いますが、これは本当に素晴らしいスタートです。私はそれをテストしました、そしてそれは完全に機能しています。

于 2014-07-11T06:40:01.877 に答える
5

Sandcastleを使用してプレーンな HTML を生成し、それを使用することになりました。必然的に、独自のパーサーまたは Sandcastle 用のカスタム テンプレートを作成するだけです。

Doxygen や QDoc の学習曲線が好きではありませんでした。

于 2012-07-13T20:17:13.097 に答える
3

私はDoxygenをお勧めします。構成ファイルと XSLT を使用して Doxygen を構成することで、ほぼ何でも実行できます。http://www.doxygen.nl/

ソース ファイルと出力を構成ファイルに設定し、XSLT を使用して出力をカスタマイズします。

Doxygen にはパーサー ツール ( http://code.google.com/p/doxygenxmlparser/ ) があり、C# で多くの作業を行うために既に用意されています。

if(youDoNotLikeThisIdea == true) 高度に構成可能な別のツールは、QDoc (Qt API の一部) @ http://qt-project.orgです。もちろん、QDoc を使用するには、特に Qt と QDoc をビルドする必要があります。

幸運を！

于 2012-07-13T08:27:33.867 に答える