首页 > 代码库 > 文件注释方法
文件注释方法
每个人都有自己注释的风格,不强求格式一样。
基本注释内容:
类注释:
/** * 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 //这是一个变量。
文件注释方法
声明:以上内容来自用户投稿及互联网公开渠道收集整理发布,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任,若内容有误或涉及侵权可进行投诉: 投诉/举报 工作人员会在5个工作日内联系你,一经查实,本站将立刻删除涉嫌侵权内容。