美文网首页
Java项目开发规范

Java项目开发规范

作者: Apple_Boy | 来源:发表于2019-07-05 08:51 被阅读0次

    1.命名规范:

        *所有标识都只能用ASCII字母、数字和下划线

        *类名是一个名词,采用大小写混合的方式,每个单词的首字母大写  如:NeeKe

        *方法名是一个动词或动词词组,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写,如setNeeKeName(String neekeName)

        *变量名第一个字母大写,任何中间单词的首字母大写。要简短顾名思义,便于记忆,如:neekeName、neekeAddress  避免单个字符的变量名(springset方法),除非是一次性的临时变量。不能出现类似a等名称的变量

        *常量的声明应该全部大写,每个单词之间用_连接  如:final String WWW_INEEKE_CN="www.ineeke.com"

    2.注释规范:

        *注释尽可能用//  所有的javadoc用/**  */  临时对代码块注释/* */

        *源文件都应该在开头有一个注释,其中列出文件名、日期和类的功能概述

        *每个方法必须添加文档注释【类的main除外】,注释内容为参数说明,如果一个类里面的方法是由多个人完成的,每个方法注明是谁写的

        *每个属性必须注释

    3.缩进版本规范:

        使用Eclipse的格式化ctrl+f

    4.文件命名规范:

        *一个java源文件只能存储一个java类

        *文件名与java类名相同

    5.声明规范:

        *一行声明一个变量

        *不要将不同类型变量的声明放在同一行

        *只在代码块的开始处声明变量

        *编码声明的局部变量覆盖上一级声明的变量

        *方法与方法之间以空行分隔

    6.语句规范:

        *每行至少包含一条简单语句

        *在return语句中,返回值不适用小括号"()"括起来

        *if语句总是用"{" 和"}"括起来

        *在for语句的初始化或更新子句中,避免使用三个以上变量而导致复杂度提高

        *当switch的一个case顺着往下执行时(因为没有break),通常在break语句时位置添加注释!

        *while if for 等循环嵌套语句不能超过三层

    7.编程规范:

        *提供对实例以及类变量的public或者private访问控制,尽可能不适用默认值或者protected访问控制

        *避免使用一个对象访问一个类的静态变量或方法,应该使用类名

        *避免在一个语句中给多个变量赋相同的值

        *用于设置对象状态的方法前缀必须是set;用于检索一个布尔类型对象状态的方法必须是is;用于检索其他方法前缀必须是get

        *程序中应该尽可能少使用数字(或字符),尽可能定义静态变量来说明该数字(或字符)的含义---使用枚举类???程序中需要进行赋值或比较时,使用前面定义的静态变量。在循环控制中例外

        *所有的异常应该都向上抛出

    相关文章

      网友评论

          本文标题:Java项目开发规范

          本文链接:https://www.haomeiwen.com/subject/pfojhctx.html