定义规范的目的是为了使项目的代码样式统一,使程序有良好的可读性。软件开发的过程其实就是代码编写的过程,这和写作很像,也必不可免的需要一些编码规范,一些代码编写时的规定,可以帮助我们减少软件开发中出现的bug问题,提升软件的质量。这里,给大家分享一些在Java项目开发中一定要知道的编码规则,或者说编码规范。
命名规范1、项目名全部小写
2、包名全部小写
3、类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。
如:publicclassMyFirstClass{}
4、变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。
如:intindex=0;
publicvoidtoString(){}
5、常量名全部大写
如:publicstaticfinalStringGAME_COLOR=”RED”;
6、所有命名规则必须遵循以下规则:
★1)、名称只能由字母、数字、下划线、$符号组成
★2)、不能以数字开头
★3)、名称不能使用JAVA中的关键字。
★4)、坚决不允许出现中文及拼音命名。
注释规范1、类注释
在每个类前面必须加上类注释,注释模板如下:
/**
*Copyright(C),-,ChengDuLovoinfo.Co.,Ltd.
*FileName:Test.java
*类的详细说明
*
*
author类创建者姓名*
Date创建日期*
version1.00*/
2、属性注释
在每个属性前面必须加上属性注释,注释模板如下:
/**提示信息*/
privateStringstrMsg=null;
3、方法注释
在每个方法前面必须加上方法注释,注释模板如下:
/**
*类方法的详细使用说明
*
*
param参数1参数1的使用说明*
return返回结果的说明*
throws异常类型.错误代码注明从此类方法中抛出异常的说明*/
4、构造方法注释
在每个构造方法前面必须加上注释,注释模板如下:
/**
*构造方法的详细使用说明
*
*
param参数1参数1的使用说明*
throws异常类型.错误代码注明从此类方法中抛出异常的说明*/
5、方法内部注释
在方法内部使用单行或者多行注释,该注释根据实际情况添加。
如://背景颜色
ColorbgColor=Color.RED
上面这些关于代码编写的命名规则与注释规范在软件开发的过程中可以有效的帮助你,提升你的软件质量,在软件开发过程里,你一定要遵循这些Java开发规范。
芯学苑暑假班
开课时间:年07月13日抢座中..
-