首页 / PHP / 记录PHP,如果我扩展一个类,我应该复制/粘贴吗？

记录PHP,如果我扩展一个类,我应该复制/粘贴吗？

内容导读

互联网集市收集整理的这篇技术教程文章主要介绍了记录PHP,如果我扩展一个类,我应该复制/粘贴吗？，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含1523字，纯文字阅读大概需要3分钟。

内容图文

我有一个带有方法的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,如果我扩展一个类,我应该复制/粘贴吗？全部内容，希望文章能够帮你解决记录PHP,如果我扩展一个类,我应该复制/粘贴吗？所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。

内容备注

版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。

内容手机端

扫描二维码推送至手机访问。

本文链接：https://qyyshop.com/info/789405.html

来源：【匿名】