Java基础——注释规范
2017-04-29 21:17
232 查看
一、注释格式分类:
1、单行(single-line)注释://……
2、块(block)注释:/*……*/
3、文档注释:/**……*/
javadoc有如下:
二、加注释的场景:
1. 基本注释(必须加)
(a)类(接口)的注释
(b)构造函数的注释
(c)方法的注释
(d)全局变量的注释
(e)字段/属性的注释
2. 特殊必须加注释(必须加)
(a)典型算法 必须有注释。
(b)在代码不明晰处必须有注释。
(c)在代码修改处加上修改标识的注释。
(d)在循环和逻辑分支组成的代码中加注释。
(e)为他人提供的接口必须加详细注释。
三、注释示例
类的注释——请使用IDE的模板定义类注释模板
字段属性注释
全局变量注释
方法注释
1、单行(single-line)注释://……
2、块(block)注释:/*……*/
3、文档注释:/**……*/
javadoc有如下:
二、加注释的场景:
1. 基本注释(必须加)
(a)类(接口)的注释
(b)构造函数的注释
(c)方法的注释
(d)全局变量的注释
(e)字段/属性的注释
2. 特殊必须加注释(必须加)
(a)典型算法 必须有注释。
(b)在代码不明晰处必须有注释。
(c)在代码修改处加上修改标识的注释。
(d)在循环和逻辑分支组成的代码中加注释。
(e)为他人提供的接口必须加详细注释。
三、注释示例
类的注释——请使用IDE的模板定义类注释模板
/** * 测试类 * @author jiangbei01 * @version 1.0 * * */ public class Test01 {
字段属性注释
private String username;//用户名,字段属性注释
全局变量注释
/**统计次数*/ private final int count= 18;
方法注释
/** * 测试方法 * @param n 循环次数 * */ @Test public void fun1(int n){
相关文章推荐
- Java基础学习总结(92)——Java编码规范之排版、注释及命名
- java基础2.Java命名规范与注释规范
- java基础第一讲——JDK、注释、帮助文档、编码规范
- Java基础学习总结(92)——Java编码规范之排版、注释及命名
- java编码规范_缩进和注释
- Java注释规范整理
- java基础巩固训练营【第一轮】(一)项目环境和规范 补充
- java 规范(命名、注释 、Java 文件样式)
- Java语言基础-与注释有关的语法
- java学习数据库操作基础更规范的写法——————调用类
- JAVA代码编程规范-Java基础-Java-编程开发
- Java标准注释及规范
- java学习数据库操作基础更规范的写法——————工具类
- Java注释的规范写法
- Java注释规范整理
- JAVA的注释规范
- java基础巩固训练营【第一轮】(一)项目环境和规范
- Java 程序编码规范-Java基础-Java-编程开发
- Java注释规范
- Java基础学习(02Java语言的特点、机制与规范)