問題タブ [xml-documentation]

Visual Studio 2005（VS.8.0）を使用しており、パブリックメンバーだけでなく、すべてのクラスメンバーを文書化するという要件を適用したいと考えています。パブリック、保護、または内部で保護されたメンバーが文書化されていない場合に警告を生成するようにVisual Studioをセットアップするのは簡単ですが、プライベートメンバーと内部メンバーに同じ警告をスローさせる方法を探しています。助言がありますか？

注：警告レベル4を使用しており、警告をエラーとして扱い、XMLの生成フラグを設定しています。

私がそのように定義された添付プロパティを持っていると仮定します：

プロパティ識別子（MyPropertyProperty）とアクセサ（GetMyPropertyと）のドキュメントを書くことはできますが、実際のコード要素ではないため、MyClass.MyProperty添付プロパティSetMyPropertyのドキュメントをどこに置くかわかりません。

MSDNライブラリにはそのようなドキュメントが含まれているため（たとえばを参照Grid.Row）、それが可能である必要があります...

添付プロパティのXMLドキュメントコメントはどこに配置すればよいですか？

この2つの方法があれば

そして、別の方法でこのxmlドキュメントを書きます

の下に青い波線が表示されGet、あいまいな参照 'Get'であることがわかります。これは本当ですが、両方を参照したいと思います。これを行う正しい方法は何ですか？それとも、単一のメソッド オーバーロードのみを参照する必要がありますか?

xmlコメントを使用するC＃プロジェクトがあります。Sandcastleヘルプファイルビルダーを使用して、Sandcastleでそれらからchmファイルを作成します。このプロジェクトのメンバー関数の1つは、埋め込まれたリソースを利用します。ヘルプファイルで参照したい。sandcastleはこれをサポートしていないようですが、解析するxmlドキュメントファイルはサポートしています。私は次の例のためにこれを言います

そのコードをコンパイルし、結果のxmlドキュメントからchmをコンパイルすると、ビルドログに次のようになります。

そして、備考セクションは次のとおりです。

ReSharperのAgentSmithが提案し、 <see/>要素をビルドログに変更すると、次のようになります。<see cref="Resources.TextFile"/>

そして、chmの備考セクションは次のように変更されます。

だから私の質問は2つの部分です：

1. リソースを参照するための<see/>要素の使用は正しいですか？
2. サンドキャッスルが生成するchmファイルに埋め込まれたリソースを参照するようにする方法はありますか？

文書化したい XML ファイルとスキーマがいくつかあります。このプロジェクトのすべては、NetBeans UML モデル、Microsoft Word ドキュメント、Microsoft Excel スプレッドシート、および Microsoft Visio 図面を使用して文書化されています。私は自己文書化のファンですが、これは私の選択ではありません。外部文書を作成する必要があります。これらのツールを使用して XML ファイルとスキーマをグラフィカルに表現するにはどうすればよいですか?

Currently the documentation where I work is in a bit of a state. There isn't anywhere near enough of it, and the documentation that does exist is spread out over many word documents making it hard to find anything.

I'm trying to take some initiative and get it improved, and I figure the first thing is to find a better format to write the documentation in:

• My thoughts are that the documentation should be structured in a series of short articles (MSDN / Html Help style) and structured in a suitable tree:
  • It would be good to be able to produce a standalone Html-Help style package to be shipped with the application
  • As well as being able to produce a MSDN-style website as a reference for those who are too lazy to look at the CD.
  • Search is of course a must-have
• It needs to be at least reasonably easy to update - if there is a 17 step process to update the published documentation then it makes it seem like too much work to do simple changes, and nobody can ever be bothered to update it.
• The documentation is technical in nature, and so ideally it would be nice to be able to include generated documentation from things like the Xml documentation embedded in C# code. This is however definitely a side-requirement - currently very little useful Xml documentation exists, its just that in the future I plan to fix that.
• For the same reason it is often good to be able to handle things like attachments (code samples etc...) I'm not expecting anything fancy, but this is something I need to bear in mind to make sure that its at least not handled badly.

Are there any projects or languages that are suited to this sort of documentation?

Javadoc コメントを C# ドキュメント コメントに変換するツールを知っている人はいますか?

XMLファイルの構造を文書化することになると...

私の同僚の1人がWordテーブルでそれを行っています。

もう1つは、次のようなコメントを含む要素をWord文書に貼り付けます。

これらの方法のどれが好ましいですか？もっと良い方法はありますか？

更新にサードパーティのSchemaDocumenterツールを必要としない他のオプションはありますか？

私GhostDocは自分のコードの XML ドキュメントに使用しています。これには、私がよく使用するきちんとした「自動ドキュメント」機能があります。そのため、列挙型でそれを使用したところ、私が知らない奇妙なハッシュコードを思いつきました。よくわかります。

それはなんのためですか？次のようになります。

{35A90EBF-F421-44A3-BE3A-47C72AFE47FE}