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 文档注释只能出现在特定类型的元素上，如所述in this article :

In source code files, documentation comments that precede the following can be processed and added to the XML file:

Such user-defined types as a class, delegate, or interface

Such members as a field, event, property, or method

如果您在文件中放置一个文件级 XMLDoc 样式的注释，它将附加到下一个类或恰好出现的其他元素。某些文档工具(如 SandcaSTLe)提供了一种添加 namespace 级 XMLDoc 注释的方法，但它们通常出现在单独的文件中。

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