微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

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

我理解,如果你///在类,字段,方法属性之上,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.有人可能希望将此问题视为重复.

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。