标签：php phpdoc

我有一个带有方法的PHP类.在基类中(它更像是原型,但我不使用原型,因为我们必须向后兼容),我记录了方法的参数和描述.

现在我扩展那个班级.在这个新方法(实现)中,我应该重新记录参数和描述,我应该留空,还是应该只留下适用于该特定实现的相关注释？

我的目标是拥有由PhpDoc生成的可读API文档,并遵循惯例.

解决方法:

看一下Zend Framework中的几个例子,似乎评论大多是复制粘贴的 – 这有时会导致不同的评论.

我将采用的第一个例子是Zend_Http_Client_Adapter_Interface :: connect,它被声明为：

/**
 * Connect to the remote server
 *
 * @param string  $host
 * @param int     $port
 * @param boolean $secure
 */
public function connect($host, $port = 80, $secure = false);

而且,如果你看一下实现这个接口的类,比如Zend_Http_Client_Adapter_Curl,你会看到：

/**
 * Initialize curl
 *
 * @param  string  $host
 * @param  int     $port
 * @param  boolean $secure
 * @return void
 * @throws Zend_Http_Client_Adapter_Exception if unable to connect
 */
public function connect($host, $port = 80, $secure = false)

所以,复制粘贴的参数;以及实施中的更多信息.

另一个例子是Zend_Log_Writer_Abstract :: _ write：

/**
 * Write a message to the log.
 *
 * @param  array  $event  log data event
 * @return void
 */
abstract protected function _write($event);

并且,在子类中,如Zend_Log_Writer_Db：

/**
 * Write a message to the log.
 *
 * @param  array  $event  event data
 * @return void
 */
protected function _write($event)

在这里,再次,复制粘贴;父类中的一个小修改,尚未在子类中重新创建.

现在,我一般做什么？

>我一般认为开发人员不经常写评论
>并且通常忘记更新它们
>所以,我试着让他们的生活更轻松,不要重复评论
>除非子类中的注释必须与父类中的注释不同.

标签：php,phpdoc
来源： https://codeday.me/bug/20190627/1300419.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。