我正在添加一些csharp代码的注释,我正在使用.net(或其他)提供的xml语言.我有一个接口,以及一些实现类.我在界面中有一个方法,它有一个注释.在实现类中,没有对实现方法的评论.
当一个人在java中这样做时,javadoc在生成文档时自动使用接口注释.然而,现在我建立了我的项目,我收到了警告(从瑞典转发,抱歉)“缺少可见类型或成员bla.blabla.blablabla()的xml注释(cs1591)”.这只是一个警告,所以不是那么糟糕.但!!!这意味着没有输出xml文件,所以我不能使用sandcastle生成一个chm文档文件,这是我真正的目标….谷歌搜索错误编码什么都没有:(
我真的必须将方法注释复制到所有实现类吗?就像….代码重复D:有没有办法得到java提供的行为?
解决方法:
我不知道在XML文件生成时间有什么办法让它发生,但GhostDoc可能会让你无法手动执行复制.我不能说我自己也用过它.
我同意它将是一个有价值的特性…特别是如果在实现和记录派生类之后基类(或接口)文档发生了变化.