文件注释方法

每个人都有自己注释的风格,不强求格式一样。

基本注释内容:

  类注释:

/**
 * 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   说明,介绍。

  方法注释:

  

    /**
     * Construct function.
     * 
     * @access public
     * @return void
     */

  短注释:

/* Save session. */

  变量说明:

$var //这是一个变量。

  

原文地址:https://www.cnblogs.com/canbefree/p/3940849.html