PHPCS 注释样例

 

文件和类注释：主要包含以上内容块：文件说明、PHP 版本号、还有就是按顺序的这五要素：(category, package, author, license, link)

/**
 * PHP version 7.2.4
 *
 * @category Controller
 * @package  App\mobile\controller
 * @author   一二三四 <luzeqi@xingzhi.com>
 * @license  XZY http://www.baidu.com
 * @link     http://www.baidu.com
 */

/**
 * The control file of dashboard module of ZenTaoPMS.
 *
 * @copyright   Copyright 2009-2013 青岛易软天创网络科技有限公司 (QingDao Nature Easy Soft Network Technology Co,LTD www.cnezsoft.com)
 * @license     LGPL (http://www.gnu.org/licenses/lgpl.html)
 * @author      Chunsheng Wang <chunsheng@cnezsoft.com>
 * @package     dashboard
 * @version     $Id: control.php 5020 2013-07-05 02:03:26Z wyd621@gmail.com $
 * @link        http://www.zentao.net
 */

 第一行写这个类的作用

　　@copyright：自己的劳动成果最好加上这一句。

　　@license：

　　@author ：名字和邮箱

　　@package  dashboard

　　@version 　版本

　　@link　　　说明，介绍。

 

方法注释: 主要包含：方法说明、空一行、参数块 (类型、参数名、含义 —— 这个需要对齐)、空一行、最后

 /**
     * 创建统计
     *
     * @param string $school_year_id 学年id
     * @param string $company_uuid   单位id
     *
     * @throws /Exception
     * @return boolean
     */