PHP评论格式：自动生成还是用户创建？

发布时间：2020-12-13 17:01:50 所属栏目：PHP教程来源：网络整理

导读：我总是在php中看到这些标题注释,并且经常想知道是否有一些软件用于设置它们？我好像回忆起 JavaDoc还是什么？但我不确定这是否是自动生成的？或者这只是某种类型的文档标准？以下示例来自CodeIgniter： /** * CodeIgniter * * An open source application d

我总是在php中看到这些标题注释,并且经常想知道是否有一些软件用于设置它们？我好像回忆起 JavaDoc还是什么？但我不确定这是否是自动生成的？或者这只是某种类型的文档标准？

以下示例来自CodeIgniter：

/**
 * CodeIgniter
 *
 * An open source application development framework for PHP 4.3.2 or newer
 *
 * @package     CodeIgniter
 * @author      ExpressionEngine Dev Team
 * @copyright   Copyright (c) 2008,EllisLab,Inc.
 * @license     http://codeigniter.com/user_guide/license.html
 * @link        http://codeigniter.com
 * @since       Version 1.0
 * @filesource
 */

我真的想改进我的评论,我觉得这对我的项目来说是一个很好的形式.

解决方法

它是 phpDoc,它被一些带有反射的框架用来动态地理解和使用类(通过代码本身).

IDE还会将它用于自动完成,显示函数参数等.如果您的IDE为您使用的框架提供了这些功能,而不是您编写的代码,那么这一点很好.

PHP’s Reflection API

Zend Framework Extension (including DocBlocks)

CodeIgniter’s Comment Guide (Using DocBlock ‘…so they can be picked up by IDEs’)

DocBlock Description on phpdoc.org (linked from CI’s Style Guide)

（编辑：李大同）

【声明】本站内容均来自网络，其相关言论仅代表作者个人观点，不代表本站立场。若无意侵犯到您的权利，请及时与联系站长删除相关内容!