下面是比较常用的一些注释变量和说明,日程用的时候可以根据类或者方法选择性的使用
一、常用的注释说明
/**
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息
* @example 示例
* @exclude 指明当前的注释将不进行分析,不出现在文挡中
* @final 指明这是一个最终的类、方法、属性,禁止派生、修改。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量,并加入相应的超级连接。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @todo 指明应该改进或没有实现的地方
* @var 定义说明变量/属性。
* @version 定义版本信息
*/
二、打样demo
现在写代码基本都会加这些注释,看起来是不是很清爽呢
- 2023-08: 经过多年的检验,部分字段可以移除,减少注释量(减少的部分基本不会变化且会被其他同事直接复制过去还不调整)
一、常用的注释说明
/**
*
* 实际的注释信息,实际编写保留这两个即可,除非大公司有特殊要求
*
* @author 函数作者的名字和邮箱地址
*
*/
注:代码都是快速生成的哦,程序员都很懒,才不会手敲呢,多累啊
附上快速生成注释的配置方式,还没配置的小伙伴赶紧试试吧,是不是很贴心(记得打开大图查看哦)