MSDNのスタイルCHM [閉じた]を生成するためのC ++ XMLコメント
-
21-08-2019 - |
質問
私はいくつかのプロジェクトを持って、マネージコードを使用して、いくつかの、いくつかだけで管理されていない使用。すべてのXMLコメントが追加されていていると、XML文書は(XDCファイル生成されたXMLファイルと中間)を正しく生成されています。
確かに、これらのファイル(xdcmakeの出力)に乗り、MSDNスタイルのCHMヘルプを生成することができるものがあります! ? 私が理解からは、doxygenをとサンドキャッスルの両方が明らかにステップし、コードを再スキャンするホイールを再発明することを無視します。 (サンドキャッスルがnon-.NETプロジェクトのために明らかに無用であるという事実もあります)。
の両方がはるかに簡単な何かに負けじとする物乞いされました。doxygen(恐ろしい出力が、速い)とサンドキャッスル(素敵なMSDNのスタイルの出力が、sloooooow)を試してみましたた。
我々はまた、また、任意のAPIドキュメントを必要としているページの「はじめに」と「情報」の種類を書くことができることに関連するエディタのいくつかの種類があった場合は、またいいだろう。
誰か解決策を知っていますか?
解決
あなたは DoxyComment にしようとする場合があります。ここではdoxygenのヘルパーツール&スクリプトからの説明はをされます:
と呼ばれるVisual Studio 2005のためのアドイン DoxyCommentはTroelsによって作成されました グラム。であなたを支援するために設計されています コンテキストに応じたコメントを挿入します C / C ++ソースファイルにブロックします。 DoxyCommentまた、XSLTが付属しています あなたが生成することができますテンプレート MSDNライブラリなどのドキュメントます。
他のヒント
正直なところ、サンドキャッスルは、あなたの最善の策です。私はそれを設定するには、痛みのビットであることを知っていますが、ドキュメントは正確にあなたが探しているスタイルです。
私は、人々はまだ使用してプロジェクトを知っている NDocConsoleする
しかし、私はされたNdocが原因 http://ndoc.sourceforge.net/に、死んだプロジェクトであると仮定します>何のアップデートが2005年から存在しない。