1. ホーム
  2. c#

C#コードのhtmlドキュメントを作成する【非公開

2023-09-19 06:47:08

質問

現在、C#のプロジェクトで作業していますが、VisualAssistはこのような派手なものを生成します。 /// <summary></summary> コメントを生成してくれて、それを自分のコードの文書化に使っています。

私は、DoxygenやJavadocによって行われるようなHTMLドキュメントを作成するためにこれらのコメントを使用する方法があるに違いないと仮定しています。どのようにすればよいのでしょうか?

どのように解決するのですか?

酸素 または サンドキャッスル・ヘルプファイル・ビルダー は、XMLドキュメントをHTML(および他の形式)の外部ドキュメントに抽出する主要なツールです。

これらのドキュメントエクスポーターをドキュメントジェネレーターと組み合わせることができることに注意してください - あなたが発見したように、Resharperはいくつかの初歩的なヘルパーを持っていますが、この特定のタスクを行うためのはるかに高度なツールもあります、それは例えば GhostDoc (C#/VBコードとXMLドキュメントの組み合わせ)や、私のアドインである Atomineer Pro ドキュメント (C#, C++/CLI, C++, VB, Java, JavaScript, TypeScript, JScript, PHP, Unrealscript コードに XML, Doxygen, JavaDoc または Qt ドキュメントを含む場合) があります。