2

私: 私は .NET プラットフォームに比較的慣れていません。

問題

Java では、package-info.java または package.html ファイルを作成してパッケージ フォルダーに保存することにより、パッケージ レベルのドキュメントをプロジェクトに追加できます。Visual Studio 2010 を使用して C# のプロジェクトに同等のドキュメントを追加するにはどうすればよいですか?

バックグラウンド

私が取り組んでいるソース コード プロジェクトのパッケージ/フォルダー レベルのコンテキストで、私の動機を説明するドキュメントを書くのが好きです。私はさまざまな言語 (特に Java) でのこのワークフローに非常に慣れており、自分のプロジェクトを文書化する良い方法だと信じています。

4

2 に答える 2

3

C＃は、XMLベースのトリプルスラッシュコメントをインテリセンスドキュメントに自動的に変換します。

///<summary>This method does something!</summary>
///<parameter name="p1">The first parameter</parameter>
///<return>true, if the method completed successfully</return>
public bool DoSomething(int p1){
  return p1 > 0;
}

プロジェクトをクラスライブラリにコンパイルして別のプロジェクトで参照すると、上記は自動的に便利なツールチップになります。さらに、C＃コンパイラは、オプションで、DLLと一緒にこれらすべてのコメントを含むXMLファイルを生成できます。このXMLファイルは（前述のように）Sandcastleにフィードし、MSDNスタイルのAPIリファレンスとしてドキュメントプロジェクトに追加できます。

Sandcastleツールには独自のプロジェクトとドキュメント構造があるため、XMLで生成されたIntellisense参照以外のものを追加する場合は、サイドプロジェクトを開始することをお勧めします。

于 2010-05-24T23:17:02.450 に答える
1

.NETでは焦点が少し異なり、IntelliSense情報を生成するための非常に優れたサポートがあります。あなたの指先でドキュメント。VSをしばらく使用したことで、よく知っていると思います。「xmlドキュメント」を参照してください。

オフラインドキュメントは以前はNDocでカバーされていましたが、それをサポートした人はプロジェクトを終了しました。サンドキャッスルプロジェクトは緩みを取りました。ところで、最近も少し遅れているようです。

于 2010-05-24T23:07:23.497 に答える