代码注释标准大全
2015-08-09 00:00
387 查看
/** * @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 定义版本信息 */
相关文章推荐
- java并发(一) CountDownLatch (在多个线程都结束后再去执行某个任务)
- django book学习笔记――高级视图和URL配置
- 《深入浅出struts2》--第23章,自定义插件
- Python-Selenium2做Web自动化测试(1)-软件测试分类以及什么时候需要进行自动化测试
- ognl表达式的部分功能
- ASP通过ODBC连接SQL Server 2008数据库的方法
- [150808]十个我希望早点知道的Python方法
- (六)面向对象的设计原则之二
- 从外部引入整个工程到eclipse中后,工程前面出现小红叉
- 《C++编程思想》 第十一章 运算符重载 (原书代码+习题+解答)
- Java的类继承机制 -- 应用于接口系统测试
- PyQt5初级教程--PyQt5中部件[8/13]
- JavaStep --- 3. 读取输入
- ACM中关于Output Limit Exceeded和Time Limit Exceeded
- 深入理解Aop编程思想
- VC 多线程编程
- Django 1.8 官方教程翻译(第一部分)
- ognl表达式入门
- Python中For each 与Remove使用中误区
- 如何删除JAVA集合中的元素