你的位置:首页 > Java教程

[Java教程]Java学习笔记(1):注释规范


注释规范

1、   类注释

在每个类前面必须加上类注释,注释模板如下:

 java学习笔记(1):注释规范

 

2、   属性注释

在每个属性前面必须加上属性注释,注释模板如下:

java学习笔记(1):注释规范

3、   方法注释

在每个方法前面必须加上方法注释,注释模板如下:

java学习笔记(1):注释规范

4、   构造方法注释

在每个构造方法前面必须加上注释,注释模板如下:

java学习笔记(1):注释规范

 

5、   方法内部注释

在方法内部使用单行或者多行注释,该注释根据实际情况添加。

如:

       Color bgColor = Color.RED    //背景颜色