C# 文件是否可以包含文件级摘要注释

本文关键字：文件 注释 是否 包含 | 更新日期: 2023-09-27 18:35:19

例如

福.cs：

using System;
/// <summary>
/// This file contains Foo and Bar-related things.
/// </summary>
namespace Xyz {

class FooThing {
}
}

C# 是否支持此类 XMLDoc 注释？

C# 文件是否可以包含文件级摘要注释

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

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

类、委托或接口等用户定义类型

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

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

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

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

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

  • 类、委托或接口等用户定义类型

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

相关文章：