c# - C# 文件可以包含文件级摘要注释吗？

Question

例如

Foo.cs：

using System;

/// <summary>
/// This file contains Foo and Bar-related things.
/// </summary>

namespace Xyz {


class FooThing {
}

}

C# 是否支持这样的 XMLDoc 注释？

Answer 1

不可以，XML 文档注释只能出现在特定类型的元素上，如本文所述：

在源代码文件中，可以处理以下前面的文档注释并将其添加到 XML 文件中：

诸如类、委托或接口之类的用户定义类型

字段、事件、属性或方法等成员

如果您在文件中放置文件级 XMLDoc 样式的注释，它将被附加到下一个类或碰巧出现的其他元素。某些文档工具（如 Sandcastle）提供了一种添加名称空间级别 XMLDoc 注释的方法，但它们通常出现在单独的文件中。

当然，您可以在每个文件中使用非XMLDoc 样式的注释，例如版权标题或类似内容，只需使用标准的 /* */ 样式注释块。

Answer 2

根据/doc 文档，不，不支持。

在源代码文件中，可以处理以下前面的文档注释并将其添加到 XML 文件中：

• 诸如类、委托或接口之类的用户定义类型

• 字段、事件、属性或方法等成员