web-dev-qa-db-ja.com

Visual Studio C ++ドキュメントジェネレーター

Visual C++プロジェクトでドキュメント(javadocなど)を取得する方法はありますか?

Visual Studio 2010を使用しています。

ありがとう!

23
hara

VS2010でサポートされているXML-Documentation形式も使用できます。 http://msdn.Microsoft.com/en-us/library/ms177226%28VS.80%29.aspx

コードにコメントを付けた後、Sandcastleを使用してMSDNのようなドキュメントを作成できます: http://sandcastle.codeplex.com/ 。 (これは、SandcastleのGUI表現であり、はるかに使いやすくなっています: https://github.com/EWSoftware/SHFB

AtomineerUtilsを使用して、XML-Documentationヘッダーを自動的に作成します。このツールはあなたに大いに役立ちます。ここで無料の基本バージョンを使用できます: http://www.atomineerutils.com/products.php

20
Simon

Doxygen をご覧ください。

13
KTC

また、 CppTripleSlash-c ++のxmlドキュメントコメント もご覧ください。これは無料のVisual Studio 2015、2013、2012、2010拡張機能です。

3
DWORD

私のアドイン Atomineer Pro Documentation を使用して、Documentation-XML、Doxygen、Qt、またはJavaDoc形式のドキュメントコメントをすばやく生成できます。次に、Sandcastle(DocXml)またはDoxygen(DocXml、Doxygen、Qt、Javadoc)を使用して、このドキュメントを外部ドキュメントファイルに変換します。

上記のすべてのツールがDocXml形式で機能し、Visual Studioがそれを認識するので(構文に色を付け、ドキュメントをIntelliSenseデータベースに構築するので、クラス/メソッドを入力するとツールチップのヘルプに表示されるので、DocXml形式を使用することをお勧めします。コードに名前を付けます)。

3
Jason Williams

ドキュメントを生成する1つの方法は、あなたが推測したとおりjavadocです。通常と同じようにコメントを付けるだけで、javadocがHTML/LaTeXスタイルに変換します。

もちろん、それが唯一の解決策ではありません。他の人のために部屋を空けておきます。

1
Xavier Ho

気にしないのであれば、手書きのドキュメントがあれば、sphinxは完璧なツールです。

http://www.sphinx-doc.org/en/stable/

そしてここに例があります:

http://ceres-solver.org/

sphinx-build -b singlehtml doc/ build/
0
sailfish009

Visual Studio 2015を使用している場合は、マクロ言語にJavaScriptを使用するMacro Explorer拡張用に作成されたDoxygenジェネレーターがあります。

プロジェクトはここのgithubにあります: https://github.com/cppocl/visual_studio_macros

0
user2827968