NDoc有一个XML元素inheritdoc,它允许您从父类(或实现的接口)继承成员的文档。但是,Visual Studio(即C#编译器)不理解此标记,并抱怨文档不存在或完整。 StyleCop和一些其他工具。有另一种方法吗?如何保持文档完整,但没有重复XML描述?
一个替代方法是使用
GhostDoc – Visual Studio的加载项,自动为您生成注释。这与当前的XML描述重复,这是你想要避免的一部分 – 但至少它自动为你。
如果你完全离开文档完全为继承的方法或覆盖接口方法会发生什么?我怀疑这取决于你如何配置NDoc,但肯定在MSDN文档似乎只是自然继承的文档 – 一个快速检查表明VS不会whinge当你不产生文档继承的方法。值得一试,当然。
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。