我使用 xml 注释来记录组件的公共成员以及内部成员和私有成员。我想将生成的文档 xml 文件与组件程序集打包,以便为最终产品启用“丰富”(例如,包含方法、异常和参数描述)的 Visual Studio Intellisense。问题在于,C# 编译器为所有内容(包括内部类、方法、内部枚举的私有字段等)创建文档条目,并且似乎没有切换到“仅公共成员”模式。
现在,我不想查看超过 50 个文件,每个文件中都包含 XX 方法,并删除私有和内部成员的所有注释。即使我这样做了,我也可能不会在自动生成资源文件方面取得太大成功,因为这些强类型资源类会自动注释并且是非公开的。
我的问题是:是否有一些我忽略的选项/标志?如果没有,是否有一些工具可以帮助将公共成员与其他成员分开(在我开始编写代码之前)?
SandCastle 帮助文件生成器有一个选项可以重新创建仅包含方法、属性等配置的访问模式的 xml 文件...
唯一的“缺点”是您必须生成文档。
EDIT
由于很久以前我忘记了我向 SHFB 添加了一个“组件”来生成 XML。
好消息是该组件已包含在 SHFB 中。
您必须将“Intellisense 组件”添加到 SHFB 项目中。然后它将根据配置的 SHFB 项目生成 XML。
欲了解更多信息:SHFB 中的智能感知组件 http://www.ewoodruff.us/shfbdocs/html/5d546511-6aec-455a-ba09-9daffb124c6d.htm
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)