我已经启用了在我的类库上生成XML文档,该类库有一个父类和许多继承的类。从基类属性中重写了几个属性。我想将XML注释放在基类属性上,并对重写的属性获得相同的注释。不幸的是,当我生成XML Doc文件时,覆盖的属性上缺少注释。是否可以覆盖基类的xml注释?
答案 0 :(得分:0)
根据您用于生成外部文档(Doxygen,Sandcastle等)的工具,您可以使用include
或类似元素从其他地方提取文档,以便可以共享它。
另一种方法是使用see
,seealso
或sa
条目(再次,取决于您处理文档注释的工具)来引用基类属性/方法,但是这将意味着指向基本条目的超链接,而不是内联文档。
第三种可能性是我的插件,AtomineerUtils。 (除此之外)它会将基类/接口的文档复制到您的覆盖/实现中,因此只需要一点时间来复制文档。然后,您可以修改复制的文档,使其更加特定于附加到的特定方法。