【问题标题】:Multi-line style comments causing XML documentation warning导致 XML 文档警告的多行样式注释
【发布时间】:2013-02-15 16:57:10
【问题描述】:

我在一个 C# 项目中有许多多行样式 cmets,当项目选项设置为输出 XML 文档文件时,它们都会触发警告 XML 注释没有放在有效的语言元素上 .在 Visual Studio 2010 中观察到此行为。

将所有这些 cmets 更改为单行样式 cmets 我该怎么做才能防止触发这些警告?

简化示例:

public class Foo
{
    /// <summary>
    /// Does something.
    /// </summary>
    public void DoSomething()
    {
        /**
         * Do something interest here.
         */
    }
}

【问题讨论】:

  • 跟双星有关系吗?这就像 Java 中的文档注释...将其更改为 /* 而不是 /**

标签: c# visual-studio-2010 xml-documentation


【解决方案1】:

只需删除评论第一行的第二个*

C 风格的 XML doc cmets 使用 /** 打开。

【讨论】:

  • 我明白了,只有/** 触发警告,第一行中任何其他数量的* 都不会触发警告。感谢@SLaks 和@applechewer。
猜你喜欢
  • 2018-03-28
  • 2020-02-24
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2010-11-01
  • 2016-05-29
  • 2020-12-30
相关资源
最近更新 更多