【问题标题】:What are XML Comments in C# Used For? [duplicate]C# 中的 XML 注释有什么用? [复制]
【发布时间】:2013-01-22 02:06:54
【问题描述】:

可能重复:
What are the virtues of using XML comments in .NET?

/// <summary>
///  Set error message for multilingual language.
/// </summary>

像上面那样在 C# 中使用 XML 注释有什么用,我什么时候使用它们.. XML Comments 带有 3 引号,是否有针对 XML Comments 的块注释过程,例如 /* ... */

【问题讨论】:

标签: c# xml xml-comments


【解决方案1】:

XML cmets 是一种记录代码中类型和成员的结构化方法。如果您使用它,编译器将为您的类型和成员生成 XML 文档,然后可以通过 Sandcastle 之类的工具进行处理以自动构建帮助。 Visual Studio 也使用生成的 XML 文件中的信息(以提供智能感知)。

您可以通过以下方式使用multiline delimiters

/** <summary>
Your info here
*/

虽然工具不会以这种形式生成它。

有关详细信息,请参阅 MSDN 上的XML Documentation Comments

【讨论】:

    【解决方案2】:

    这是一种记录代码的方式。这是一个参考

    http://msdn.microsoft.com/en-us/magazine/dd722812.aspx

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 2011-02-04
      • 2011-02-02
      • 1970-01-01
      • 2011-09-30
      • 2011-06-07
      • 1970-01-01
      • 2018-05-19
      相关资源
      最近更新 更多