Java代码规范--排版,命名

简介: Java代码规范--排版,命名

一 排版规范
1:对于变量的初始化赋值时候,= 要对齐,这样看着整齐舒服
// Before
private Char joe = 'joe';
private Char johnny = 'johnny';
private Char quaid = 'quaid';

// After
private Char joe = 'joe';
private Char quaid = 'quaid';

//代码效果参考:http://0791zd.com/zx/art_4534.html

      2:关键词或者变量和操作符之间加一个空格:
  for(int i = 0; i < 10; i++) {
    int iCont = 1;
  }

      3: 相对独立的代码块与块之间加空行,例如方法之间加上空行
      4:较长的语句、表达式要分成多行书写
      5:main方法写在整个类的底部

    二 命名规范
           1:包的命名,全部是小写字母
           2:Class名以及成员变量名,方法名遵循驼峰规则
           3:Class 中 Static Final 变量的命名,static Final 变量的名字应该都大写,并且指出完整含义。

    三 注释规范
            1:类,方法的注释采用 eclipse 自动生成方法。 /**
                  当把一个类,或方法的声明写完整后,在类,方法的正上方(不许有空格)在英文输入
                  法状态下输入:/** 后,系统会自动生成他们的注释模板,我们只需要填写相应的说明文字
                  即可,注意:/**的下一行一定要写功能说明。
    四 例子

 * Java编码格式个人推荐,参考JDK源码和Hyperic HQ源码(原spring旗下著名开源软件,现vmware)。   
 * @author lihzh(苦逼coder)   

 */   
public class CodeRule {   
     //代码效果参考:http://0791zd.com/bx/art_3373.html

    //声明变量,等号两边有空格。   
    private static int i = 1;   

    //方法声明,右括号和左大括号中间有空格。   
    public static void main(String[] args) {   
        //if语句,比较连接符(>)左右有空格,小括号和大括号中间有空格。   
        //if 与 左括号中间有空格   
        if (i > 0) {   
            System.out.println(i);   
        }   
        //两个条件的连接(&&),左右有空格。   
        if (i > 0 && i < 2) {   
        //if..else 语句两种格式   
        //1.参考JDK,个人使用方式,else跟大括号,前后都有空格   
        } else if (i > 2) {   
            System.out.println(i + 1);   
        } else {   
        //2.参考Hyperic HQ源码, else另起一行,后仍有空格   
         if (i == 1) {   
             System.out.println(i);   
         }   
         else {   

         //while语句,与if语句类型,while与括号中间有空格,括号内格式与if相同   
         while (i > 0 && i < 2) {   
             i++;   
         //for语句,两种格式   
         //1.参考Hyperic HQ,个人使用方式。分号后带空格,每个子语句中,连接符左右都带空格。   
         //for与括号中间带空格,大小括号中间带空格。   
         for (int j = 0; j < 10; j++) {   
         //2.参考JDK,区别在于子语句中,连接符左右无空格。   
         for (int j=0; j<10; j++) {   
         //+-*/,格式,四则运算符号前后有空格。   
         //在JDK的有些代码里,在方法调用的参传递或在判断语句中存在的四则运算中,四则运算符号前后无空格。   
         //为了不造成困扰和混淆,个人为均保留空格。   
         int a = 1 + 2;   
         int b = 1 - 2;   
         int c = 1 * 2;   
         int d = 1 / 2;   
    //代码效果参考:http://0791zd.com/bx/art_2349.html
         //三元表达式格式,每个符号中间均有空格   
         int j = i > 2 ? 1 : -1;   
         //方法声明和调用,用逗号分隔的参数,逗号后有空格。   
         sum(a, b);   
         sum(c + d, j);   
    }   
    //方法声明,多个参数,逗号后有空格   
    private static int sum(int i, int j) {   
        return i + j;   
相关文章
|
2月前
|
运维 Java
Java版HIS系统 云HIS系统 云HIS源码 结构简洁、代码规范易阅读
云HIS系统分为两个大的系统,一个是基层卫生健康云综合管理系统,另一个是基层卫生健康云业务系统。基层卫生健康云综合管理系统由运营商、开发商和监管机构使用,用来进行运营管理、运维管理和综合监管。基层卫生健康云业务系统由基层医院使用,用来支撑医院各类业务运转。
57 5
|
6天前
|
Java 开发者
Java变量命名的规则
Java变量命名的规则
|
15天前
|
存储 Java
从菜鸟到大神:Java标识符命名的“蜕变”之路!
【6月更文挑战第15天】Java标识符命名关乎代码质量。从新手到专家,理解并遵循命名规范至关重要。好的命名应具描述性、简洁和一致性。变量用小写下划线(如my_variable),类用驼峰式(如MyClass)。避免关键词,使用有意义的名称,保持命名一致性,谨慎使用缩写,且勿在名称中含数字。示例代码展示了这些原则,如`UserManager`、`getUserById`,显示了良好命名实践的价值。**
|
28天前
|
Java API 应用服务中间件
Java一分钟之-JNDI:Java命名和目录接口
【6月更文挑战第3天】JNDI,Java Naming and Directory Interface,是Java的API,用于访问命名和目录服务。本文聚焦JNDI常见问题和易错点:1) 初始化Context时需正确配置环境属性;2) 查找资源时确保名称与服务器配置一致;3) 别忘了导入JNDI库和妥善处理异常;4) 使用后记得关闭资源。理解JNDI并避免这些问题能提升应用的可维护性和灵活性。
43 2
|
2月前
|
Java 程序员
命名之美:探索Java的标识符与命名规范
命名之美:探索Java的标识符与命名规范
|
2月前
|
存储 Oracle Java
Java 包和 API 深度解析:组织代码,避免命名冲突
Java 中的包 用于将相关的类分组在一起。可以将其视为文件目录中的一个文件夹。我们使用包来避免名称冲突,并编写更易于维护的代码。 包分为两类: 内置包(来自 Java API 的包) 用户定义的包(创建自己的包)
320 2
|
2月前
|
设计模式 Java 程序员
优雅整洁的 Java 代码命名技巧,风之极·净化
优雅整洁的 Java 代码命名技巧,风之极·净化
119 0
|
10月前
|
SQL 安全 Java
Java阿里巴巴代码规范
Java阿里巴巴代码规范
13418 0
|
10月前
|
算法 安全 Java
Java代码规范的重要性
Java代码规范的重要性
202 0
|
12月前
|
网络协议 Java 数据库连接
了解JNDI:Java中的命名和目录服务接口
了解JNDI:Java中的命名和目录服务接口
304 1