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样式的注释,例如版权标题或类似注释,只需使用标准的/**/样式注释块.