web-dev-qa-db-ja.com

参照として追加された場合、アセンブリにサマリーが表示されません

C#で「クラスライブラリ」を作成しました。これには、要約付きの多くの関数があります(XMLドキュメントコメント)。

例えば

///<summary>
///Adds the two numbres
///</summary>
public void Add()
{
    //statements
}

同じ名前空間で関数を使用すると、概要が表示されますが、他のワークスペース(ソリューション)で参照として追加すると、概要が表示されません。

参照として追加された場合に他のソリューションで表示されるようにするにはどうすればよいですか?

45

アセンブリのXMLドキュメント(myassembly.xmlという名前のファイル)を生成し、他のプロジェクトによって参照されている.dllと一緒にコピーする必要があります。手順については MSDNのこのページ を参照してください。

45
Jon
  1. ソースコードのソリューションエクスプローラーに移動します。 プロジェクト名を右クリックして、プロパティに移動します。
  2. c#を使用している場合はビルドタブに移動し、チェックボックスXmlドキュメントファイルを選択します。
  3. ソースコードをビルドすると、DLLが存在する場所にXmlファイルが生成されます。
  4. dllをソリューションにコピーしながら、xmlファイルをコピーして、宛先ソリューションのビンに貼り付けます。
54
Pushparaj

Xmlコメントを持つクラスをコンパイルすると、通常、.xmlファイルが作成されます。 (Visual Studioのオプションを確認してください)

そのようなアセンブリへの参照を追加するときは、XMLファイルが存在することを確認してください。ドキュメントはアセンブリ内ではなく、xmlファイル内に含まれています。

2
TimothyP