**代码注释规范**
~~~
/**
* 测试方法
*
* @ApiTitle (方法名test)
* @ApiSummary (测试描述信息)
* @ApiAuthor (接口作者)
* @ApiMethod (POST)
* @ApiRoute (/api/demo/test/)
* @ApiHeaders (name=token, type=string, required=true, description="请求的Token")
* @ApiParams (name="id", type="integer", required=true, description="会员ID")
* @ApiParams (name="name", type="string", required=true, description="用户名")
* @ApiParams (name="data", type="object", sample="{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}", description="扩展数据")
* @ApiReturnParams (name="code", type="integer", required=true, sample="0")
* @ApiReturnParams (name="msg", type="string", required=true, sample="返回成功")
* @ApiReturnParams (name="data", type="object", sample="{'user_id':'int','user_name':'string','profile':{'email':'string','age':'integer'}}", description="扩展数据返回")
* @ApiReturn ({
'code':'1',
'msg':'返回成功'
})
*/
public function test()
{
$this->success('返回成功', $this->request->param());
}
~~~
| 标签 | 实例 | 说明 |
| --- | --- | --- |
| @abstract | | 抽象类的变 和方法 |
| @access | public, private or protected | 文档的访问和使用权限。@ ccess private表明这个文档是私有的 |
| @author | 小明 | 文档作者信息 |
| @copyright | 名称时间 | 文档版权信息 |
| @deprecated | Version | 文档中被废除的方法 |
| @deprec | | 同 @deprecated |
| @example | /path/to/example | 文挡的外部保存示例文件的位置 |
| @exception | | 文档中方法抛出的异常,也可参照@ hrows |
| @global | 类型 $globalvarname | 文档中的全局变量及有关的方法和函数 |
| @ignore | | 忽略文档中指定的关键字 |
| @internal | | 开发团队内部信息 |
| @link | URL | 类似于lic se ,但还可以通过访问 地址找到文档中更多的详细信息 |
| @name | 变量别名 | 为某个变量指定别名 |
| @magic | | PHPDoc兼容phpDocumentor的标签 |
| @package | 封装包的名称 | 一组相关类、函数封装的包名称 |
| @param | usemame 用户名 | 输入变量含义注释 |
| @return | 如返回bool | 输出函数返回结果描述,一般不用在vo id 空返回结果的〕的函数中 |
| @see | Class Login() | 文件关联的任何元素(全局变量,包括页面、类、函数、定义、方法、变量〉 |
| @since | version | 记录什么时候对文档的哪些部分进行了更改 |
| @static | | 记录静态类、方法 |
| @staticvar | | 在类、函数中使用的静态变量 |
| @subpackage | | 子版本 |
| @throws | | 抛出的异常 |
| @todo | | 表示文件未完成或者要完善的地方 |
- 办公器材
- 办公用品清单
- 办公购材料
- 文档
- 销售文档
- 需求确认合同
- ui合同
- 需求文档
- 技术文档
- 开发类文档
- 代码规范
- php代码规范
- 数据字典规范
- 类库说明
- 封装规范
- 代码注释规范
- 接口文档书写
- 状态码说明
- 接口书写规范文档
- 工具类文档
- 环境搭建文档
- 常用工具使用说明
- 版本控制协同开发
- 系统镜像
- 接口测试工具
- 雇佣文档
- 雇佣合同
- 人力资源文档
- 会议管理文档
- 发文规范文档
- 档案管理文档
- 车辆管理文档
- 电脑规范文档
- 电话使用文档
- 交接文档
- 岗位职责文档
- 入职流程文档
- 入职培训文档
- 员工培训文档
- 情报文档
- 财务
- 质量管理文档
- 规章制度
- 第一章:总则
- 第二章:员工日常行为规范
- 第三章 聘任管理制度
- 第四章 作息与考勤制度
- 第五章 请假制度
- 第六章 离职制度
- 第七章 移交制度
- 第八章 晋升制度
- 第九章 薪资制度
- 第十章 奖惩制度
- 奖励
- 工龄奖
- 考勤奖
- 内推奖
- 年度贡献奖
- 年度人气奖
- 培训奖
- 绩效奖
- 部门奖
- 惩罚
- 失职
- 投诉
- 其他
- 运营途径
- 市场调研
- seo
- 软文
- 抖音
- 活动
- 开源代码
- 微信qq
- 地推
- 电销
- 第三方外包平台
- 水军
- 接口平台
- 品牌
- 品牌故事
- pinpoint符号
- 吉祥物
- 品牌词
- 广告语
- 产品
- 工具
- 企划书
- 企业环境
- 启动资金
- 企业规划书