非 XML 中的 C# 文档

Question

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

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

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

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

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

Answer 1

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

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