java程序有哪些编码规范?详细说明

阳光 2021-02-23 17:13:05 java常见问答 3267

规范性问题是作为一个程序员都应该注意的事情,只有做好了相应的规范,也就可以顺利的编程代码了,那么java程序有哪些编码规范?接下来,我们就来给大家讲解一下这方面的内容。

一、命名规范

1、尽量使用完整的英文描述符;

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

3、采用大小写混合使名字可读;

4、尽量少用缩写,但如果用了,必须符合整个工程中的统一定义;

5、避免使用长的名字(小于 15 个字母为正常选择);

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

7、避免使用下划线(除静态常量等);

二、注释规范

1、Java 文件:必须写明版权信息以及该文件的创建时间和作者;

2、类:类的目的、即类所完成的功能,以及该类创建的时间和作者名称;多人一次编辑或修改同一个类时,应在作者名称处出现多人的名称;

3、接口:在满足类注释的基础之上,接口注释应该包含设置接口的目的、它应如何被使用以及如何不被使用。在接口注释清楚的前提下对应的实现类可以不加注释;

4、方法注释:对于设置 (Set方法 ) 与获取 (Get方法 ) 成员的方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么且返回值什么;另外方法的创建,时间必须注释清楚,为将来的维护和阅读提供宝贵线索;

三、代码格式规范

遵循工程规定的统一代码格式,一般情况下直接使用 IDE(Eclipse) 自带的默认代码格式对代码进行格式化;

四、其他规范

JSP 文件命名:采用完整的英文描述说明 JSP 所完成的功能,尽可能包括一个生动的动词,第一个字母小写,如: viewMessage.jsp 、editUser.jsp 等。

在编写代码的时候,程序员一定要做好以上这些规范,遵守规范才能顺利的开发程序!最后大家如果想要了解更多java常见问题知识,敬请关注奇Q工具网。

推荐阅读:

java怎么做出界面?实例讲解

java有多少个关键字?java错误处理关键字有哪些?

java异常怎么避免?java异常是什么?