非 XML 中的 C# 文档答案

【问题标题】：C# Documenting in non XML非 XML 中的 C# 文档
【发布时间】：2015-10-22 11:51:42
【问题描述】：

在 C# 中，您可以添加带有 XML 标记的 cmets。 Visual Studio 将在其自动完成中使用 cmets，因此您可以很好地了解该方法。

///<summary>
///summary description
///</summary>
public void Method1() { }

我觉得上面的方法有点冗长......似乎还有另一种方法。我已经看到在 Unity 3D 引擎中使用了这个。但是当我尝试复制它时，Visual Studio 不会使用注释块中提供的信息自动完成。以下是 Unity 的做法：

//
// Summary:
//     ///
//     summary description
//     ///
public void Method1()

有谁知道为什么上面的“代码”不起作用？

【问题讨论】：

因为只有 Unity 接受它...
你在哪里看到像这样团结一致的 cmets？您是否在方法上单击“转到定义”并查看函数的“元数据视图”？
@ScottChamberlain 确实
基于previously-asked questions和existing resources out there，在C#（包括Unity/MonoDevelop）中添加摘要cmets的规定方式是使用XML。您可以使用任何其他方式...但不要期望它们会被许多 IDE 支持。

【解决方案1】：

在元数据视图中，您查看的不是实际代码。它所做的是读取 DLL 并构建文本以在元数据视图中为您显示。

如果您可以查看实际来源，您会发现它也在使用 XML 标记。

【讨论】：