当前位置:  开发笔记 > 编程语言 > 正文

仅为公共成员提取xml注释

如何解决《仅为公共成员提取xml注释》经验,为你挑选了1个好方法。

我正在使用xml注释来记录我的组件的公共以及内部和私有成员.我想将生成的文档xml文件与组件程序集打包在一起,以便为最终产品启用"丰富"(例如,使用方法,异常和参数描述)Visual Studio Intellisense.它的问题是C#编译器为所有内容(包括内部类,方法,内部枚举的私有字段等)创建文档条目,并且似乎没有切换到"仅公共成员"模式.

现在我不想在每个文件中使用XX方法查看超过50个文件,并删除私人和内部成员的所有注释.即使我这样做,我可能也不会在auto-gen'd资源文件上取得太大成功,因为这些强类型资源类会自动注释而非公开.

我的问题是:是否有一些选项/标志我忽略了?如果不是,是否有一些工具可以帮助将公共成员与其他成员分开(在我开始编写代码之前)?



1> Stécy..:

SandCastle帮助文件构建器可以选择重新创建仅包含方法,属性等的已配置访问模式的xml文件...

唯一的"缺点"是你必须生成一个文档.

编辑

由于很久以前我忘记了我向SHFB添加了一个"组件"来生成XML.

好消息是该组件包含在SHFB中.

您必须将"Intellisense Component"添加到SHFB项目中.然后,它将根据配置的SHFB项目生成XML.

有关更多信息:SHFB中的Intellisense组件

推荐阅读
臭小子
这个屌丝很懒,什么也没留下!
DevBox开发工具箱 | 专业的在线开发工具网站    京公网安备 11010802040832号  |  京ICP备19059560号-6
Copyright © 1998 - 2020 DevBox.CN. All Rights Reserved devBox.cn 开发工具箱 版权所有