考虑一下我有一个复杂的类结构，其中许多元素继承自其他元素。我可能有一个方法GetStuff(string stuffName, int count)在接口中定义，该接口由其他接口继承，然后由抽象类抽象实现，然后在具体类中显式实现，等等......
我应该如何处理继承的成员，例如GetStuff()当用 XML 注释记录我的代码时，这些注释将与 Doxygen 或 Sandcastle 等工具一起使用？在每个级别复制并粘贴相同的描述似乎是错误的。我是否应该在界面级别和具体类级别考虑不同的受众？例如，接口处的 GetStuff() 文档可能会考虑实现该接口的人，而具体级别的文档可能会考虑将使用该类的人？
记录接口方法根据其代码合同。不要评论它的实现，只评论它的语义目的，即它应该做什么，而不是如何做。本文档的受众是both你的实施者and您的用户：该方法将被实现并被调用。
记录抽象方法只需说它实现了接口方法并链接到它即可。对此没有什么额外可说的，并且重复注释违反了 DRY（不要重复自己）原则：您必须记住在以下位置对其进行任何更改：both地方。 （当然，对于不实现接口方法的抽象方法，请以与记录接口方法相同的方式记录它。）
记录具体实施通过说它实现了接口方法和/或它覆盖了抽象成员。 （可选）添加有关其实现的信息如果它与调用者相关——例如，它的性能特征，或者它可能抛出的情况等。
本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)
