JAVA代码书写规范有哪些
JAVA代码书写规范有哪些,针对这个问题,这篇文章详细介绍了相对应的分析和解答,希望可以帮助更多想解决这个问题的小伙伴找到更简单易行的方法。
在肥东等地区,都构建了全面的区域性战略布局,加强发展的系统性、市场前瞻性、产品创新能力,以专注、极致的服务理念,为客户提供成都网站制作、成都网站设计 网站设计制作按需策划设计,公司网站建设,企业网站建设,品牌网站建设,成都全网营销推广,外贸网站制作,肥东网站建设费用合理。
一般原则
尽量使用完整的英文描述符 采用适用于相关领域的术语 采用大小写混合增强可读性 尽量少用缩写,但如果用了,要明智地使用,且在整个工程中统一 避免使用长的名字 避免使用类似的名字,或者仅仅是大小写不同的名字 避免使用下划线(除静态常量等)
命名的字母大小写问题
包名: 字母全小写 例如: cn.coderstory.Activity.Main 类,接口 :首字母大写,其他全小写 例如: class Container 方法,变量 :第二个单词开始首字母大写 例如: seedMessage 常量: 大写,单词用“_”分割 例如: final static MIN_WIDTH = 4 接口 :首字母大写 ,后缀Impl 例如: class ContainerImpl 异常类: 首字母大写, 后缀Exception 例如: DataNotFoundException 抽象类 :首字母大写, 前缀Abstract 例如: AbstractBeanDefinition Test类: 首字母大写, 后缀Test 例如: public Location newLocation()
方法的命名
类中获取值方法,一般要求被方法名使用被访问字段名,前面加上前缀get,如getLastUser(), getUserCount() 返回布尔型的判断方法一般要求方法名使用单词 is 做前缀,如isPersistent(),isString()。或者使用具有逻辑意义的单词,例如equal 或equals 用于修改某些设置的方法(一般返回类型为void):被访问字段名的前面加上前缀 set,如setFirstName(),setLastName(),setWarpSpeed()。 已办的方法一般采用完整的英文描述说明成员方法功能,第一个单词尽可能采用一个生动的动词,第一个字母小写,如 openFile(), addAccount()。 接口 :首字母大写 ,后缀Impl 例如: class ContainerImpl 异常类: 首字母大写, 后缀Exception 例如: DataNotFoundException 抽象类 :首字母大写, 前缀Abstract 例如: AbstractBeanDefinition Test类: 首字母大写, 后缀Test 例如: public Location newLocation()
Java注释约定
类的整体注释:遵循JavaDoc的规范,在每一个源文件的开头注明该CLASS的作用, 作简要说明, 并写上源文件的作者, 编写日期。如果是修改别人编写的源文件,要在修改信息上注明修改者和修改日期。
例如:
/*** @(#):CLASSNAME.java* @description: Description of this java* @author: PROGRAMMER'S NAME YYYY/MM/DD* @version: Version No.* @modify:* @Copyright: 版权由拥有*/
类中方法的注释:遵循JavaDoc的规范,在每个方法的前部用块注释的方法描述此方法的作用,以及传入,传出参数的类型和作用,以及需要捕获的错误。
例如:
/*** 方法的描述***@param 参数的描述*@return 返回类型的描述*@exception 出错信息的描述*/
行注释:使用//…的注释方法来注释需要表明的内容。并且把注释的内容放在需要注释的代码的前面一行或同一行。 块注释:使用/**和*/注释的方法来注释需要表明的内容。并且把注释的内容放在需要注释的代码的前面。 注释哪些部分:类的目的(即类所完成的功能)、设置接口的目的以及应如何被使用、成员方法注释(对于设置与获取成员方法,在成员变量已有说明的情况下,可以不加注释;普通成员方法要求说明完成什么功能,参数含义是什么?返回什么?)、普通成员方法内部注释(控制结构、代码做了些什么以及为什么这样做,处理顺序等)、实参和形参的含义以及其他任何约束或前提条件、字段或属性描述。而对于局部变量,如无特别意义的情况下不加注释。
JAVA文件声明顺序
类或接口应该按以下顺序声明(其实是加载顺序的问题):
包的定义 impot类(输入包的顺序、避免使用*)输入包应该按照java.*.*,javax.*.*,org.*.* ,com.*.*的顺序import在import的时候不应该使用* (例如: java.util.*) 类或接口的定义 静态变量定义,按public,protected,private顺序 实例变量定义,按public,protected,private顺序 构造方法 方法定义顺序按照public方法(类自己的方法),实现接口的方法,重载的public法,受保护方法,包作用域方法和私有方法。建议:类中每个方法的代码行数不要超过100行。 内部类的定义
关于JAVA代码书写规范有哪些问题的解答就分享到这里了,希望以上内容可以对大家有一定的帮助,如果你还有很多疑惑没有解开,可以关注创新互联行业资讯频道了解更多相关知识。
当前名称:JAVA代码书写规范有哪些
标题路径:http://azwzsj.com/article/gjdcpe.html