2011-05-27 2 views
1

私は直接答えを見つけることができないという問題があります。私はいくつかの友人とゲームエンジンを構築している段階の後半にいます。この時点で、チームに参加したいと思うデベロッパーにとって読みやすく、便利にするためにコメントを合理化しようとしています。 Visual Studio 2010を使用しているので、埋め込まれたXMLコメントは完璧なツールのようでした。唯一の問題は、私たちのエンジンが基づいているグラフィックスライブラリが同じアイデアを持っているように見えることであり、XMLのようなコメントスキーマも使用するということです。残念なことに、XMLコメントをコンパイルするために使用したツールの構文は、Visual Studioで使用されているものと似ていません。そのため、Visual StudioがコメントをプロジェクトのXML出力ファイルに表示しようとすると、私たちは私たちのコードのドキュメントだけを必要としているので、プロセスを縛り、完全に不要になります。要するに、Visual Studio/VC++で設定できるコンパイラのパラメータやオプションは、クラスやドキュメントのXMLコメント出力ファイルを生成するだけです。どうもありがとうございます。Visual C++は自分のファイルだけにXMLコメントを生成させますか?

+0

あなたのコメントを削除できますか?私はVSがどのファイルがあなたのものであるかを知っているはずです。 – Fosco

+0

@Fosco - プロジェクトのフォルダまたはソリューションにのみ存在するものはありますか?私のプロジェクトに含まれているヘッダーファイルのコメントを生成しているので、リンカはコンパイル時の環境全体の一部としてそれらを含めていますが、実際には自分のプロジェクトフォルダに存在していないか、 XMLパーサーが2つのXMLパーサーを区別できる必要があるとは思わないでしょうか? – DaveStance

答えて

2

Visual Studioを忘れて、doxygenのような実際のドキュメント生成ツールを使用してください。 MS XMLベースのドキュメントを処理し、特定のファイルまたはディレクトリのみを検索するように構成できます。


EDIT doxygenは、それが自分のドキュメンテーションタグ形式described hereのしているが、それはまたのJavaDocスタイルのコメントを処理します。 XMLスタイルのコメントはdescribed hereです。

+0

あなたは男です!おかげで、このツールは素晴らしいです!私は自動化されたC++ドキュメントの一般的な検索を行ったときにこれが注目を集めていなかったことに驚いています。 – DaveStance

+0

問題ありません。個人的には、私はDoxygen自身のマークアップタグをXMLマークアップよりも好まれます(タイピングが少ない、より優れた機能)。 XMLマークアップを使用する必要があるかどうかはわかりませんが、doxygenのタグやJavaDocマークアップを使用することをお勧めします。一方、Visual Studioは自動的にXMLマークアップをスタブし、とにかくdoxygenスタイルのマークアップに混在させることができます... –

関連する問題