我正在向一些csharp代码添加注释,并且我正在使用.net(或其他东西)提供的xml语言。我有一个接口和一些实现类。我在界面中有一个方法,它有一个注释。在实现类中没有对实现方法进行注释。
当人们在java中这样做时,javadoc在生成文档时会自动使用接口注释。然而,现在我构建了我的项目,我收到警告(从瑞典语翻译过来,抱歉)“可见类型或成员 bla.blabla.blablabla() 的 xml 注释丢失 (cs1591)”。这只是一个警告,所以还不错。但!!!这意味着没有输出 xml 文件,所以我不能使用 sandcastle 生成 chm 文档文件,这是我真正的目标......谷歌搜索错误编码没有给出任何结果:(
我真的必须将方法注释复制到所有实现类吗?这就像......代码重复D:有没有办法获得java提供的行为?
我不知道有什么方法可以让它在 XML 文件生成时发生,但是GhostDoc http://submain.com/products/ghostdoc.aspx很可能使您免于手动执行复制。但我不能说我自己用过它。
我同意这将是一个有价值的功能......特别是如果基类(或接口)文档在派生类实现和记录之后发生更改。
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)