1

评论重写的类或方法时公认的最佳实践是什么。

  1. 是否应该复制父类或方法的注释并添加一个简短的注释来解释为什么以及如何修改它。
  2. 是否应该使用 @see 标记链接到父元素(php docblock)
  3. 任何其他公认的标准
4

2 回答 2

0

使用@see标签,但添加任何可能偏离扩展/覆盖类/方法的信息。例如,@author 可能不同,该方法会做一些额外的事情(假设它没有定义抽象方法)所以请注意这一点。

于 2012-11-20T18:11:54.937 回答
0

这取决于您使用的文档,他们应该在其中概述它的细节,但是如果您使用“php docblock”,那么是的,如果没有阅读您使用的手册,请使用@see

于 2012-11-20T18:16:07.333 回答