命名空间的 XML 文档 [英] XML-documentation for a namespace

问题描述

你会为命名空间编写 xml-doc 吗?如果是，如何以及在哪里?

Would you write xml-doc for a namespace? And if yes, how and where?

我想，如果可能的话，可能是这样一个几乎是空的文件:

I would think, if it is possible, maybe an almost empty file like this:

/// <summary>
/// This namespace contains stuff
/// </summary>
namespace Some.Namespace
{

}

但这会起作用吗?既然你......声明"，或者至少在所有其他文件中也使用命名空间......如果你在同一个命名空间的其他地方写了一个 xml 文档会发生什么?一个会消失吗?或者它们会以某种方式合并?

But will that work? Since you... "declare", or at least use the namespace in all the other files as well... and what would happen if you wrote an xml-documentation thing somewhere else on the same namespace? Would one be gone? Or would they be merged somehow?

推荐答案

NDoc 通过识别位于每个命名空间中的特殊 NamespaceDoc 类并使用其中的文档来支持这一点.我没试过，但 Sandcastle 似乎支持同样的技巧.

NDoc supports this by recognising a special NamespaceDoc class located in each namespace, and using the documentation from that. I haven't tried it, but Sandcastle appears to support the same trick.

例如:

namespace Some.Namespace
{
    /// <summary>
    /// This namespace contains stuff
    /// </summary>
    public static class NamespaceDoc
    {
    }
}

这篇关于命名空间的 XML 文档的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！