blocks|key|1716312|text|在将属性附加到方法后，我得到了这条消息|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1716313|[webMethod]
public+void+DoSomething()
{
}|code-block|syntax|javascript|1716314|但正确的方法是：|1716315|[webMethod()]+//+Note+the+Parentheses 
public+void+DoSomething()
{
}|1716316|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@]|9|@]|A|$]]|$1|B|3|C|5|D|7|N|8|@]|9|@]|A|$E|F]]|$1|G|3|H|5|6|7|O|8|@]|9|@]|A|$]]|$1|I|3|J|5|D|7|P|8|@]|9|@]|A|$E|F]]|$1|K|3|-4|5|6|7|Q|8|@]|9|@]|A|$]]]|L|$]]

I got that message after attached an attribute to a method

<pre><code>[webMethod]
public void DoSomething()
{
}
</code></pre>

But the correct way was this:

<pre><code>[webMethod()] // Note the Parentheses 
public void DoSomething()
{
}
</code></pre>

blocks|key|1501296|text|我知道这是一个非常老的帖子，但这是谷歌的第一个回复，所以我想我应该加上这一点信息：|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1501297|只有当"Project+Properties“->+"Build”下的警告级别设置为4时，才会发生此行为。除非您真的需要这么多信息，否则可以将其设置为3，这样就可以消除这些警告。当然，更改警告级别影响的不仅仅是注释，所以如果您不确定会遗漏什么，请参考文档：|1501298|https://msdn.microsoft.com/en-us/library/thxezb7y.aspx|offset|length|1501299|entityMap|0|LINK|mutability|MUTABLE|url^0|0|0|0|1I|0|0^^$0|@$1|2|3|4|5|6|7|O|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|P|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|Q|8|@]|9|@$F|R|G|S|1|T]]|A|$]]|$1|H|3|-4|5|6|7|U|8|@]|9|@]|A|$]]]|I|$J|$5|K|L|M|A|$N|E]]]]

I know this is a really old thread, but it's the first response on google so I thought I'd add this bit of information: 
 
This behavior only occurs when the warning level is set to 4 under "Project Properties" -> "Build". Unless you really need that much information you can set it to 3 and you'll get rid of these warnings. Of course, changing the warning level affects more than just comments, so please refer to the documentation if you're unsure what you'll be missing: 
<a href="https://msdn.microsoft.com/en-us/library/thxezb7y.aspx">https://msdn.microsoft.com/en-us/library/thxezb7y.aspx</a>

blocks|key|1501308|text|#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|type|code-block|depth|inlineStyleRanges|entityRanges|data|syntax|javascript|1501309|unstyled|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|G|8|@]|9|@]|A|$B|C]]|$1|D|3|-4|5|E|7|H|8|@]|9|@]|A|$]]]|F|$]]

<pre><code>#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
</code></pre>

blocks|key|1716449|text|将警告级别设置为2将禁止显示此消息。我不知道这是不是最好的解决方案，因为它也抑制了有用的警告。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1716450|entityMap^0|0^^$0|@$1|2|3|4|5|6|7|D|8|@]|9|@]|A|$]]|$1|B|3|-4|5|6|7|E|8|@]|9|@]|A|$]]]|C|$]]

Setting the warning level to 2 suppresses this messages. Don't know if it's the best solution as it also suppresses useful warnings.

blocks|key|1716502|text|您需要为显示警告的成员添加/注释。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1716503|请参见下面的代码|1716504|public+EventLogger()
{
++++LogFile+=+string.Format("{0}{1}",+LogFilePath,+FileName);
}|code-block|syntax|javascript|1716505|它为公开可见的类型或成员'.EventLogger()‘显示缺少XML注释的警告|1716506|我添加了成员的评论和警告消失了。|1716507|///<Summary>
///+To+write+a+log+<Anycomment+as+per+your+code>
///</Summary>
public+EventLogger()
{
++++LogFile+=+string.Format("{0}{1}",+LogFilePath,+FileName);
}|1716508|entityMap^0|0|0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|Q|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|R|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|S|8|@]|9|@]|A|$G|H]]|$1|I|3|J|5|6|7|T|8|@]|9|@]|A|$]]|$1|K|3|L|5|6|7|U|8|@]|9|@]|A|$]]|$1|M|3|N|5|F|7|V|8|@]|9|@]|A|$G|H]]|$1|O|3|-4|5|6|7|W|8|@]|9|@]|A|$]]]|P|$]]

You need to add /// Comment for the member for which warning is displayed.

see below code 

<pre><code>public EventLogger()
{
 LogFile = string.Format("{0}{1}", LogFilePath, FileName);
}
</code></pre>

It displays warning 
Missing XML comment for publicly visible type or member '.EventLogger()'

I added comment for the member and warning gone.

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

blocks|key|1716625|text|还有另一种方法可以抑制这些消息，而不需要任何代码更改或杂注块。使用Visual+Studio+-转到项目属性>构建>错误和警告>抑制警告-将1591添加到警告代码列表中。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1716626|​|1716627|📷|atomic|offset|length|1716628|1716629|entityMap|0|IMAGE|mutability|IMMUTABLE|imageUrl|https://ask.qcloudimg.com/http-save/yehe-900000/355a3b004f010e81c7d8797e45bc070e.png|imageAlt^0|0|0|0|1|0|0|0^^$0|@$1|2|3|4|5|6|7|S|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|T|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|U|8|@]|9|@$G|V|H|W|1|X]]|A|$]]|$1|I|3|C|5|6|7|Y|8|@]|9|@]|A|$]]|$1|J|3|-4|5|6|7|Z|8|@]|9|@]|A|$]]]|K|$L|$5|M|N|O|A|$P|Q|R|-4]]]]

There is another way you can suppress these messages without the need for any code change or pragma blocks. Using Visual Studio - Go to project properties > Build > Errors and Warnings > Suppress Warnings - append 1591 to list of warning codes.

<a href="https://i.stack.imgur.com/LaGvl.png" rel="noreferrer"><img src="https://i.stack.imgur.com/LaGvl.png" alt="enter image description here"></a>

blocks|key|1501598|text|Jon+Skeet的答案适用于使用VisualStudio进行构建的情况。但是，如果您是通过命令行(在我的例子中是通过Ant)构建sln的，那么您可能会发现msbuild忽略了sln抑制请求。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1501599|将此代码添加到msbuild命令行为我解决了这个问题：|1501600|/p:NoWarn=1591|code-block|syntax|javascript|1501601|entityMap^0|0|0|0^^$0|@$1|2|3|4|5|6|7|K|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|L|8|@]|9|@]|A|$]]|$1|D|3|E|5|F|7|M|8|@]|9|@]|A|$G|H]]|$1|I|3|-4|5|6|7|N|8|@]|9|@]|A|$]]]|J|$]]

Jon Skeet's answer works great for when you're building with VisualStudio. However, if you're building the sln via the command line (in my case it was via Ant) then you may find that msbuild ignores the sln supression requests.

Adding this to the msbuild command line solved the problem for me:

<pre><code>/p:NoWarn=1591
</code></pre>

blocks|key|1501640|text|抑制该警告的一种非常简单的方法是在.csproj文件中添加一个属性：|type|unstyled|depth|inlineStyleRanges|offset|length|style|CODE|entityRanges|data|1501641|<Project>
++++<PropertyGroup>
++++++++...+++++
++++++++
++++++++<NoWarn>$(NoWarn);1591</NoWarn>
++++</PropertyGroup>
...|code-block|syntax|javascript|1501642|entityMap^0|H|7|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@$9|N|A|O|B|C]]|D|@]|E|$]]|$1|F|3|G|5|H|7|P|8|@]|D|@]|E|$I|J]]|$1|K|3|-4|5|6|7|Q|8|@]|D|@]|E|$]]]|L|$]]

A really simple way to suppress the warning is to add a property in the <code>.csproj</code> file:
<pre class="lang-xml prettyprint-override"><code>&lt;Project&gt;
 &lt;PropertyGroup&gt;
 ... 
 &lt;!--disable missing comment warning--&gt;
 &lt;NoWarn&gt;$(NoWarn);1591&lt;/NoWarn&gt;
 &lt;/PropertyGroup&gt;
...
</code></pre>

blocks|key|1501735|text|在本文的后面，但是这个线程中的许多解决方案都专注于在项目或类中完全消除警告。|type|unstyled|depth|inlineStyleRanges|entityRanges|data|1501736|如果你想保留合法的警告，但删除一些-例如，当你使用swagger公开WebApi时，API控制器上的cancellationToken+(+api用户不需要这个-它是由DI提供的)。|1501737|丑陋而明显，但至少在这种情况下，取消令牌是最后一个参数。|1501738|++++///+<summary>
++++///+Creates+a+Service
++++///+</summary>
++++///+<param+name="service">The+Service+Definition</param>+(**note+no+cancellation+token+param**)
++++///+<returns>A+newly+created+item</returns>
++++///+<response+code="201">Returns+the+newly+created+service</response>
++++///+<response+code="400">If+there+are+validation+errors+with+the+submitted+json+body</response>
++++///+<response+code="409">Conflict.+The+service+already+exists</response>
++++///+<response+code="500">Because+life+is+never+perfect</response>
++++[ProducesResponseType(typeof(Service),+201)]
++++[ProducesResponseType(400)]
++++[ProducesResponseType(409)]
++++[ProducesResponseType(500)]
++++[HttpPost]
++++public+async+Task<ActionResult>+ServiceCreate([FromBody]+ServicePostRequest+service,
#pragma+warning+disable+1573++
++++++++CancellationToken+cancellationToken+=+default)+//**note:+no+warning**
#pragma+warning+restore+1573
++++{|code-block|syntax|javascript|1501739|entityMap^0|0|0|0|0^^$0|@$1|2|3|4|5|6|7|M|8|@]|9|@]|A|$]]|$1|B|3|C|5|6|7|N|8|@]|9|@]|A|$]]|$1|D|3|E|5|6|7|O|8|@]|9|@]|A|$]]|$1|F|3|G|5|H|7|P|8|@]|9|@]|A|$I|J]]|$1|K|3|-4|5|6|7|Q|8|@]|9|@]|A|$]]]|L|$]]

Late in here but many solutions in this thread focus on removing the warnings entirely within the project or within the class.
If you want to keep the legitimate warnings but remove some - e.g. the cancellationToken on a WebApi controller when you expose the API using swagger (the api user does not need this - it is supplied by DI).
Ugly and obvious but at least in this case cancellation tokens are the last param.
<pre><code> /// &lt;summary&gt;
 /// Creates a Service
 /// &lt;/summary&gt;
 /// &lt;param name=&quot;service&quot;&gt;The Service Definition&lt;/param&gt; (**note no cancellation token param**)
 /// &lt;returns&gt;A newly created item&lt;/returns&gt;
 /// &lt;response code=&quot;201&quot;&gt;Returns the newly created service&lt;/response&gt;
 /// &lt;response code=&quot;400&quot;&gt;If there are validation errors with the submitted json body&lt;/response&gt;
 /// &lt;response code=&quot;409&quot;&gt;Conflict. The service already exists&lt;/response&gt;
 /// &lt;response code=&quot;500&quot;&gt;Because life is never perfect&lt;/response&gt;
 [ProducesResponseType(typeof(Service), 201)]
 [ProducesResponseType(400)]
 [ProducesResponseType(409)]
 [ProducesResponseType(500)]
 [HttpPost]
 public async Task&lt;ActionResult&gt; ServiceCreate([FromBody] ServicePostRequest service,
#pragma warning disable 1573 
 CancellationToken cancellationToken = default) //**note: no warning**
#pragma warning restore 1573
 {
</code></pre>

I am getting this warning: "Missing XML comment for publicly visible type or member".

How to solve this?

Missing XML comment for publicly visible type or member

Visual Studio

我收到这样的警告：“公开可见的类型或成员缺少XML注释”。如何解决这个问题？

问缺少公开可见类型或成员的XML注释
EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问缺少公开可见类型或成员的XML注释EN

社区

活动

资源

关于

腾讯云开发者

热门产品

热门推荐

更多推荐

问缺少公开可见类型或成员的XML注释
EN