公開されているタイプまたはメンバーのXMLコメントがありません

「一般公開されているタイプまたはメンバーのXMLコメントがありません」という警告が表示されます。

これを解決するには？

5つのオプション：

• ドキュメントのコメントを入力します（素晴らしいですが、時間がかかります）
• （プロジェクトプロパティで）コメント生成をオフにする
• プロジェクトプロパティの警告を無効にします（[プロジェクトプロパティ]で[プロジェクトプロパティ]-> [ビルド]> [エラーと警告]（セクション）、警告を非表示（テキストボックス）、1591（カンマ区切りリスト）に移動）。デフォルトではアクティブ構成が変更されます。構成をすべてに変更することを検討してください。
• #pragma warning disable 1591コードの一部のビットについてのみ警告を無効にするために使用します（#pragma warning restore 1591その後）
• 警告を無視する（悪い考え-新しい「実際の」警告を見逃す）

もちろん、公開されている型とメンバーにXMLコメントを追加します:)

///<Summary>
/// Gets the answer
///</Summary>
public int MyMethod()
{
   return 42;
}

<summary>すべてのメンバーにこれらのタイプのコメントが必要です-これらはインテリセンスポップアップメニューにも表示されます。

理由は、あなたが（プロジェクト設定で）出力ドキュメントのxmlファイルにプロジェクトを設定しているので、あなたがこの警告を受けるがあります。これは、クラスライブラリ（.dllアセンブリ）に役立ちます。つまり、.dllのユーザーは、Visual StudioでAPIのインテリセンスドキュメントを入手できます。

GhostDoc Visual Studioアドインのコピーを自分で入手することをお勧めします。ドキュメント化がはるかに簡単になります。

XMLコメントの警告を抑制する

（私の仕事ではありませんが、私はそれが役に立ったので、記事とリンクを含めました）

http://bernhardelbl.wordpress.com/2009/02/23/suppress-warnings-for-xml-comments/

ここでは、Visual Studioのビルド後にXMLコメントの警告を抑制する方法を示します。

バックグラウンド

Visual Studioプロジェクト設定で「XMLドキュメントファイル」マークをチェックした場合、すべてのXMLコメントを含むXMLファイルが作成されます。さらに、XMLコメントがないか間違っているため、デザイナーが生成したファイルでも多くの警告が表示されます。警告がコードの改善と安定化に役立つこともありますが、何百ものXMLコメント警告を受け取るのは面倒です。警告

パブリックに表示されるタイプまたはメンバーの XMLコメントがありません…の XMLコメントに…のparamタグがありますが、その名前のパラメーターはありませんパラメーター…のXMLコメントに一致するparamタグがありません（ただし...）他のパラメータは行います）ソリューション

Visual Studioですべての警告を抑制することができます。

• Visual Studioプロジェクトを右クリック/プロパティ/ビルドタブ

• 「警告を非表示」に次の警告番号を挿入します：1591,1572,1571,1573,1587,1570

コードの変更やプラグマブロックを必要とせずに、これらのメッセージを抑制する別の方法があります。Visual Studioの使用-プロジェクトプロパティに移動>ビルド>エラーと警告>警告を抑制-警告コードのリストに1591を追加します。

XMLコメントを挿入します。;-)

/// <summary>
/// Describe your member here.
/// </summary>
public string Something
{
    get;
    set;
}

これは一見冗談のように見えるかもしれませんが、実際には役に立つかもしれません。私にとっては、プライベートメソッドに対してもメソッドが何をするかを考えることが役立つことがわかりました（もちろん、ささいなことを除いて）。

これは、XMLドキュメントファイルがプロジェクトプロパティで指定されており、メソッド/クラスがパブリックであり、ドキュメントがないためです。
次のいずれかを実行できます。

1. XMLドキュメントを無効にする：

   プロジェクトを右クリック->プロパティ-> 'ビルド'タブ-> XMLドキュメントファイルのチェックを外します。

2. ドキュメンテーションを自分で書いてください！

XMLドキュメントの要約は次のようになります。

/// <summary>
/// Description of the class/method/variable
/// </summary>
..declaration goes here..

私はここにリストされている答えに何かを追加したかった：

Isakが指摘したように、XMLドキュメントはVisual Studio内のすべてのコンシューマーにインテリセンスを提供するため、クラスライブラリに役立ちます。したがって、簡単で正しい解決策は、トップレベルプロジェクト（UIなど）のドキュメントをオフにすることです。これは、独自のプロジェクトの外部で実装されることはありません。

さらに、警告は一般に公開されているメンバーにのみ表示されることを指摘したかったのです。したがって、必要なものだけを公開するようにクラスライブラリを設定した場合、ドキュメントprivateやinternalメンバーなしで取得できます。

私はこれが本当に古いスレッドであることを知っていますが、それはGoogleでの最初の応答なので、このビットの情報を追加したいと思いました

。 。それほど多くの情報が本当に必要でない限り、3に設定すれば、これらの警告を取り除くことができます。もちろん、警告レベルを変更すると、コメントだけでなく、何が不足しているかわからない場合は、ドキュメントを参照してください。https：
//msdn.microsoft.com/en-us/library/thxezb7y.aspx

ソリューションでは、XMLドキュメントファイルを生成するオプションをオンにすると、パブリックメンバーのチェックが開始され、XMLDocが存在するかどうかが確認されます。そうでない場合は、要素ごとに警告が表示されます。DLLを本当にリリースしたくない場合は、ドキュメントも不要です。ソリューションに移動して、セクションを作成し、セクションをオフにしてください。それ以外の場合は、必要に応じて入力してください。重要でない場合は、プロパティとフィールド、プリコンパイラー命令でそれらを超えるだけで #pragma warning disable 1591 、警告を復元することもできます： #pragma warning restore 1591

プラグマの使用法：コンパイラの警告が表示される場所の前のコードの任意の場所...メソッド、または...ラップする必要がない場合は、呼び出して何気なく復元できます（ファイルの先頭から開始し、メソッド内で終了します）。次のコードを記述します。

#pragma warning disable 1591 復元する必要がある場合は、次を使用します。 #pragma warning restore 1591

ここに例を示します：

using System.Collections.Generic;
using System.ComponentModel.DataAnnotations;
using MongoDB.Bson;
using MongoDB.Bson.Serialization.Attributes;
using RealEstate.Entity.Models.Base;

namespace RealEstate.Models.Base
{
    public class CityVM
    {

#pragma warning disable 1591

        [Required]
        public string Id { get; set; }

        [Required]
        public string Name { get; set; }

        public List<LanguageBasedName> LanguageBasedNames { get; set; }

        [Required]
        public string CountryId { get; set; }

#pragma warning restore 1591

        /// <summary>
        /// Some countries do not have neither a State, nor a Province
        /// </summary>
        public string StateOrProvinceId { get; set; }
    }
}

プラグマディレクティブは行の先頭から始まることに注意してください

#pragma warning disable 1591
#pragma warning disable 1591
#pragma warning disable 1572
#pragma warning disable 1571
#pragma warning disable 1573
#pragma warning disable 1587
#pragma warning disable 1570

警告レベルを2に設定すると、このメッセージが表示されなくなります。有用な警告も抑制されるため、それが最善の解決策かどうかはわかりません。

Jon Skeetの答えは、VisualStudioを使用して構築する場合に最適です。ただし、コマンドラインでslnをビルドしている場合（私の場合はAnt経由でした）、msbuildがsln抑制要求を無視する場合があります。

これをmsbuildコマンドラインに追加すると、問題が解決しました。

/p:NoWarn=1591

ファイル > 編集 > プロジェクトの表示（クリック）

ドロップダウンの下部（[ 開く ] / [ 現在の作業] > [ プロパティ ]をクリック）、[出力]の[ ビルド]でプロジェクトのプロパティページを開きます。XMLドキュメントのチェックボックスを「オフ」にします。

再構築し、警告はありません。

警告が表示されているメンバーの///コメントを追加する必要があります。

以下のコードを参照してください

public EventLogger()
{
    LogFile = string.Format("{0}{1}", LogFilePath, FileName);
}

公開されているタイプまたはメンバー '.EventLogger（）'の警告Missing XMLコメントを表示します

メンバーへのコメントを追加し、警告は消えました。

///<Summary>
/// To write a log <Anycomment as per your code>
///</Summary>
public EventLogger()
{
    LogFile = string.Format("{0}{1}", LogFilePath, FileName);
}

メソッドに属性をアタッチした後、そのメッセージを受け取りました

[webMethod]
public void DoSomething()
{
}

しかし、正しい方法はこれでした：

[webMethod()] // Note the Parentheses 
public void DoSomething()
{
}