我们目前正处于一个新项目的开始阶段,并且希望(从一开始)尽可能多地评论从一开始就帮助未来的发展.
我试图找出在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)
无论如何,最重要的是要保持一致：团队中的每个成员都应该以相同的方式发表评论,遵循相同的惯例.
标签：php,eclipse,ide,phpdoc 来源： https://codeday.me/bug/20190722/1498415.html
本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享； 2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关； 3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关； 4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除； 5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。