如何正确评论重写的类或方法

时间:2012-11-20 18:09:56

标签: php comments

评论重写的类或方法时,最常用的做法是什么。

  1. 是否应复制父类或方法注释,并添加一条简短的注释,说明修改原因和方式。
  2. 是否应使用@see标记链接到父元素(php docblock)
  3. 任何其他公认的标准

2 个答案:

答案 0 :(得分:0)

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

答案 1 :(得分:0)

这取决于您使用的文件编制者应该在具体内容中概述它,但是如果您使用“php docblock”然后使用@see,如果没有阅读您使用的手册