私は作業用の内部NuGetパッケージを構築しており、できるだけ簡単に使用したいと考えています。NuGetパッケージを構築する際に関数にドキュメンテーションを追加する方法
NuGetパッケージに公開されたメソッドの関数定義と説明を含めるにはどうすればよいですか?
は、私は、関数が何をするかのこれらの詳細を提供するために、私のパッケージに追加する必要があるものはありますか?
Nugetパッケージエクスプローラツールを使用して行う方法を説明するための追加ポイント。
私は作業用の内部NuGetパッケージを構築しており、できるだけ簡単に使用したいと考えています。NuGetパッケージを構築する際に関数にドキュメンテーションを追加する方法
NuGetパッケージに公開されたメソッドの関数定義と説明を含めるにはどうすればよいですか?
は、私は、関数が何をするかのこれらの詳細を提供するために、私のパッケージに追加する必要があるものはありますか?
Nugetパッケージエクスプローラツールを使用して行う方法を説明するための追加ポイント。
このタイプのドキュメントは、XML documentation commentsで追加されます。 [Generate XML Documentation]オプションを有効にしてコンパイルすると、ドキュメントが含まれているDLLの横にXMLファイルが作成されます。これをあなたの.nuspec
ファイルに含めると、あなたのライブラリにそれを配布することができ、Visual Studioはそれを自動的に拾い上げます。あなたの機能に
は、ちょうどあなたが///
ブロックにしたいタグを含める:
/// <summary>
/// Returns "Hello World!"
/// </summary>
/// <remarks>This function is pretty useless, actually.</remarks>
public string HelloWorld()
あなたが使用できる共通の数とはrecommended tagsあります。 Visual Studioでは、これらに対していくつかのIntellisenseを提供できるはずです。
パッケージを構築している場合は、XMLドキュメントの生成オプションを有効にして、この質問で説明したように、nuspecファイルで生成されたXMLファイルを含める:How do you include Xml Docs for a class library in a NuGet package?
ちょうど自由のための 'GhostDoc'を取得し、することができます'Ctrl + Shift + D 'を使ってクラス内のすべてのものにコメントを追加する – ragerory