如何加强自己对 Java 的编码规范
大家好,我是小 Bob,一个关注软件领域而又执着于计算机底层的开发者~
Java,无疑是现在计算机专业最容易找到工作的语言,使用的人也非常多,各大语言排行榜前三一般都会有 Java。
那么,关于 Java 的使用小编这里先从它的编码规范开始,比如经常使用到的一些标识符以及关键字和注释。
一.标识符
首先,学 Java 要先弄清它的一些文件结构,这个我们下次会讲解。这里先说说它的标识符,简单来说,标识符是关于类、接口、方法、变量等起名字时使用的字符序列。
关于编程时使用标识符的一些规则:
字母、数字、下划线(_)、$所组成。
不能使用数字开头。
不能使用 Java 的关键字。
区分大小写。
To:在使用变量时,由于 utf-8 支持中文,所以是可以使用中文变量的,但小编不建议使用,如果编码不同,实际上很容易出现问题。
上面说到字符序列有类、接口、方法、变量等,下面来逐一介绍:
(1)类、接口、命名规则:
单个单词、首字母大写、其余小写
举例:Hello
多个单词:每个单词的首字母都大写,其余单词小写
举例:HelloWorld
(2)变量、方法命名规则:
单个单词:字母全小写
举例:check()
多个单词:首字母小写、后面每个单词首字母大写
举例:checkUserName()
(3)常规命名规则:
单个单词:字母全部大写
举例:NUMBER
多个单词:字母全部大写、中间使用下划线隔开
举例:MAX_VALUE
To:切记定义变量时不能用数字开头。
二.源代码注释
关于注释,华为的标准是源程序中代码的注释量要达到 30%以上,而且注释的内容要清晰明了,含义准确。间接的说明在敲代码时注释的重要性。
那么 Java 中注释有三种类别:
单行注释://
多行注释:/* */
文档注释:/** */(文档注释 Javadoc 生成的文档)
关于文档注释,便是通过命令来对源代码进行一定的信息补充,下次在使用 Eclipse 时将会讲到。
本质上来说,注释就是编译器在进行程序编译的时候,如果发现有注释的内容将不对此部分进行编译处理。Java 中可以把注释分为三种:类注释、多行注释和单行注释。
三.相关规则总结
最后,关于程序的排版规则和命名规则:
排版规则:
1.程序块采用缩进规则,缩进的空格为四个,不允许使用 TAP 缩进。
2.分界符(如大括号{}各占一行)应各独占一行,同时与引用他们的语句左对齐。
3.较长的语句、表达式或参数(>=80 字符)要分成多行书写。
4.不允许把多个短语句写在一行中,即一行只写一条语句,定义变量后应该空一行。
5.if for do while case switch default 等语句各自占一行。
6.if for do while 等语句的执行语句部分无论多少都要加括号。
命名规则:
1.类名和接口名使用意义完整的英文描述:每个英文单词的首字母使用大写,
其余字母使用小写的大小混合法。
2.方法名使用类意义完整的英文描述:第一个单词的字母使用小写,剩余单词首字母大写其余字母小写的混合法。
3.属性名使用完整意义的英文描述:第一个单词的字母使用小写,剩余单词首字母大写其余字母小写的大小写混合法。
4.常量名使用全大写的英文描述:语文单词之间使用下划线分隔开,并且使用 static final 修饰。
版权声明: 本文为 InfoQ 作者【Bob】的原创文章。
原文链接:【http://xie.infoq.cn/article/2c17d0541c3597b81b27326eb】。文章转载请联系作者。
评论