非XML的c#文档

本文关键字:文档 XML | 更新日期: 2023-09-27 18:18:58

在c#中,你可以用XML标签添加注释。Visual studio将在其自动补全中使用注释,这样你就可以看到该方法的一个很好的概述。

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

我觉得上面的方法有点啰嗦…似乎还有另一种方法。我曾在Unity 3D引擎中看到过这种情况。但是当我试图复制它时,Visual Studio不会自动完成注释块内提供的信息。Unity是这样做的:

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

有人知道为什么上面的"代码"不工作吗?

非XML的c#文档

在元数据视图中,您没有看到实际的代码。它所做的是读取DLL并构建文本,以便在元数据视图中为您显示。

如果你看一下实际的源代码,你会发现它也使用了XML标签