Java的注释,标识符及命名规范
一,Java的注释
Java注释有三种:
单行注释:快捷键Ctrl+/再次按撤销注释
一般用来注释局部变量
多行注释:Ctrl+shift+/ 撤销Ctrl+shift+\
可用来注释文件头、算法实现、方法中的复杂代码块、修改记录
文档注释:shift+alt+j
可用来注释类、接口、静态方法、成员方法、静态变量、成员变量、常量
二,常见注释
1、类注释
在每个类前面加上类注释,注释内容包括类或接口名,类和接口功能描述,作者,创建日期,所属公司、版本等:
2、属性注释
在每个属性前面必须加上属性注释,注释如下:
3、方法注释
在每个方法前面必须加上方法注释,注释如下:
4、 构造方法注释
在每个构造方法前面必须加上注释,注释如下:
5、 方法内部注释
在方法内部使用单行或者多行注释,该注释根据实际情况添加。
三,java命名规范
1、项目名全部小写
2、包名全部小写
3、类名首字母大写,若类名由多个单词构成,每个单词首字母大写,即驼峰命名法
4、变量名、方法名首字母小写,若其由多个单词构成,每个单词首字母大写,即小驼峰命名法
5、常量名全部大写
6、以上所有命名遵循规则:
名称只能由数字、字母、下划线、$符组成
不能以数字开头
不能是有Java的关键字和保留字
严禁使用汉字和拼音