java书写规范有哪些要求?java的基本书写

XIAO 2020-06-16 20:37:54 java常见问答 3406

刚刚入门学习java的小伙伴们要注意了,要从书写开始留意养成规范的代码习惯了,千万不要觉得麻烦呢,毕竟这是会受益日后工作的好习惯,下面我们就一起来看看,java书写规范有哪些要求呢?

首先呢,需要我们明确以下几点共识:

1.最好使用较为完整的英语单词描述符;

2.采用适用于相关领域的术语;

3.采用大小写混合增强可读性;

4.尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一;

5.避免使用长的名字;

6.避免使用类似的名字,或者仅仅是大小写不同的名字;

7.避免使用下划线,静态常量除外;

8.命名的字母大小写问题;

也不要觉得以上要求麻烦了,相信我,以上几点要求要是都能做到的话,下面的相关书写规范,你也不会觉得难以接受了。反而是大有裨益的对于我们以后书写代码来说。

就包名来说: 字母要求全部小写,例如: st.story.Activity.Main;

如果是类和接口 :要求首字母要大写,其余的都小写,例如: class Container;

方法,变量 :要求第二个单词开始首字母需要大写,例如: seedMessage;

常量: 要求大写,单词要用“_”来分割,例如: final static MIN_WIDTH = 4;

接口 :要求首字母大写 ,后缀以Impl结尾,例如: class ContImpl

方法的命名规范如下:

想要从类中获取值方法的话,一般是要求被方法名使用的被访问字段名,其前面加上前缀get,例如getLastUser(), getUserCount()...。

通常返回布尔型的判断方法就会要求方法名使用单词is做前缀,例如isInt(),isString()。或者也可以使用具有逻辑意义的单词,例如equal或equals。

对于接口 :首字母要大写 ,后缀是Impl,例如: class ContainerImpl;

对于异常类: 首字母要大写, 后缀是Exception,例如: DataNotFoundException;

对于抽象类 :首字母大写, 前缀Abstract 例如: AbstractBeanDefinition

Test类: 首字母大写, 后缀Test 例如: public Location newLocation()

java注释的相关规范(约定):

类中有关方法的注释:需要遵循JavaDoc的规范,在每个方法的前面用块注释的方法描述此方法的相关作用,以及传入和传出参数的类型和作用,还需要捕获的错误。

例如:

/**

* 方法的描述

*@param 参数的描述

*@return 返回类型的描述

*@exception 出错信息的描述

*/

还有行注释:使用//…的注释方法来注释需要表明的内容。并且要把注释的内容放在需要注释的代码的前面一行或者是同一行。

块注释:使用/**和*/注释的方法来注释需要表明的内容。并且把注释的内容放在需要注释的代码的前面。

那么以上就是本篇文章的所以内容了,还想了解更多java入门相关知识,记得多多关注本站最新消息哦。

推荐阅读:

java中间件有哪些?java常用中间件介绍

java判断字符串是否为数字的方法有哪些?具体方法介绍

java字符串转int,java如何将string转int?