目的:提高代码的可读性,便于纠错和具有清晰的层次感
1.良好的编码习惯
(1)每一层级之间都有一个tab的缩进距离
(2)建议一行一句只占用一行
2.良好的标识符命名习惯 标识符:所有起名字的部分:包名、类型、源文件名、变量名......
硬性要求:必须遵循
(1)标识符只能以数字,字母,下划线,$符组成,不能以数字开头
(2)标识符没有长度限制
(3)标识符严格区分大小写
(4)不能以关键字,保留字(goto,const),特殊字符(null,ture,false)组成
(5)可以用中文但是不建议~
软性要求
(1)望文生义,提高代码的可读性
(2)类名每一个单词首字母大写(TestHello)
(3)包名全小写(com.name.zmj)
(4)函数名,变量名,方法名第一个首字母小写,其他单词首字母大写(驼峰命名法:selectOne)
(5)常量全大写
3.注释:对代码程序作出的解释,提高代码可读性
(1)单行注释: // 只能解释一行的内容
(2)多行注释: /*
可以解释多行内容,可以嵌套单行注释
*/
(3)文档注释: /**
可以解释行内容
*/
文档生成指令:
1. 默认生成文档 javadoc -d . 源文件名.java(默认在源文件路径下生成)
2. 在指定的包中生成 javadoc -d 包名 源文件名.java(在指定的包中生成)
注意:注释不参与编译,所以不影响程序的编译和运行的效率