.net – XML注释 – 如何(或在何处)为命名空间和库创建XML注释？

发布时间：2020-12-16 05:37:28 所属栏目：百科来源：网络整理

导读：我理解,如果你///在类,字段,方法或属性之上,Visual Studio将开始为你建立 XML风格的注释. 但是,我在哪里可以为我的命名空间和/或库添加XML注释… 例如： .NET Framework Class Library System.Collections Namespaces System.Collections Namespace System.C

我理解,如果你///在类,字段,方法或属性之上,Visual Studio将开始为你建立 XML风格的注释.

但是,我在哪里可以为我的命名空间和/或库添加XML注释…

例如：

> .NET Framework Class Library

> System.Collections Namespaces

> System.Collections Namespace
> System.Collections.Concurrent Namespace
> ……

我不确定这些页面是手动创建的,还是通过在适当的位置添加XML样式的注释自动创建的？

这取决于您用于生成文档的工具.我相信,使用NDoc,您只需在要记录的命名空间内创建一个名为NamespaceDoc的类.然后将使用该类的XML-Comment.

由于问题标有“sandcastle”,我猜你确实在使用它.如果是这样,this SO answer应该提供详细信息.

更新：好的,我只是(in that same thread)看到Sandcastle显然也了解NamespaceDoc-classes.有人可能希望将此问题视为重复.

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!