首页 / PHP / 如何在Eclipse中使用PHPdoc
如何在Eclipse中使用PHPdoc
内容导读
互联网集市收集整理的这篇技术教程文章主要介绍了如何在Eclipse中使用PHPdoc，小编现在分享给大家，供广大互联网技能从业者学习和参考。文章包含1962字，纯文字阅读大概需要3分钟。
内容图文
我们目前正处于一个新项目的开始阶段,并且希望(从一开始)尽可能多地评论从一开始就帮助未来的发展.
我试图找出在Eclipse中使用phpDoc的最佳实践,但结果非常简洁.
您能否分享使用phpDoc在Eclipse中评论内容的最佳实践和技巧？
解决方法:
关于应该评论什么以及如何评论没有“真正的标准”,但是几乎所有评论他的代码的人都使用了一些标签.
例如,我通常至少使用：
>简短描述
>可选择一个很长的描述
> @param类型名称描述：用于函数/方法的参数
> @returns类型：用于函数/方法的返回值
> @throws ExceptionType：如果函数/方法在某些情况下抛出异常
> @see …：当我想引用另一个文件或提供更多信息的URL时
>根据项目的结构,我也可以使用@package和@subpackage
>另一个很好的,当你在类中有魔法属性时(你的IDE无法看到它们,因为它们是在代码中编写的)是@property类型$name：它允许Eclipse PDT进行自动完成,即使是魔法属性 – 例如,Doctrine使用它.
Eclipse PDT使用它们中的大多数来帮助您编写代码(尤其是@param);但是随意添加一些Eclipse PDT不使用的内容：如果从代码生成文档,它总是有用的;-)
我能给你的最好的建议是看看一些大的应用程序和/或框架的源代码(Zend Framework,Doctrine,…),看看他们的代码是如何评论的 – 很可能是他们的使用被广泛接受的东西.
例如,如果你看一下Zend Framework代码,你可以在类中找到这样的东西：
/**
* @package Zend_Cache
* @subpackage Zend_Cache_Backend
* @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
class Zend_Cache_Backend_Apc extends Zend_Cache_Backend implements Zend_Cache_Backend_ExtendedInterface
对于这样一种方法：
/**
* Test if a cache is available for the given id and (if yes) return it (false else)
*
* WARNING $doNotTestCacheValidity=true is unsupported by the Apc backend
*
* @param string $id cache id
* @param boolean $doNotTestCacheValidity if set to true, the cache validity won't be tested
* @return string cached datas (or false)
*/
public function load($id, $doNotTestCacheValidity = false)
无论如何,最重要的是要保持一致：团队中的每个成员都应该以相同的方式发表评论,遵循相同的惯例.
内容总结
以上是互联网集市为您收集整理的如何在Eclipse中使用PHPdoc全部内容，希望文章能够帮你解决如何在Eclipse中使用PHPdoc所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错，欢迎将互联网集市网站推荐给程序员好友。
内容备注
版权声明：本文内容由互联网用户自发贡献，该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容， 请发送邮件至 gblab@vip.qq.com 举报，一经查实，本站将立刻删除。
内容手机端
扫描二维码推送至手机访问。