前端之家收集整理的这篇文章主要介绍了
.NET xml文档 – 继承文档,
前端之家小编觉得挺不错的,现在分享给大家,也给大家做个参考。
NDoc有一个XML元素inheritdoc,它允许您从
父类(或实现的接口)继承成员的文档。但是,Visual Stu
dio(即C#编译器)不理解此
标记,并抱怨文档不存在或完整。 StyleCop和一些其他工具。有另一种
方法吗?如何保持文档完整,但没有重复XML描述?
一个替代
方法是使用
GhostDoc – Visual Stu
dio的加载项,
自动为您
生成注释。这与当前的XML描述重复,这是你想要避免的一部分 – 但至少它
自动为你。
如果你完全离开文档完全为继承的方法或覆盖接口方法会发生什么?我怀疑这取决于你如何配置NDoc,但肯定在MSDN文档似乎只是自然继承的文档 – 一个快速检查表明VS不会whinge当你不产生文档继承的方法。值得一试,当然。