`
火神曲
  • 浏览: 31781 次
  • 性别: Icon_minigender_1
  • 来自: 广州
最近访客 更多访客>>
社区版块
存档分类
最新评论

【6.1】Java编程惯例

阅读更多
1 提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables)

若没有足够理由,不要把实例或类变量声明为公有。通常,实例变量无需显式的设置(set)和获取(gotten),通常这作为方法调用的边缘效应 (side effect)而产生。

一个具有公有实例变量的恰当例子,是类仅作为数据结构,没有行为。亦即,若你要使用一个结构(struct)而非一个类(如果java支持结构的话),那么把类的实例变量声明为公有是合适的。

2 引用类变量和类方法(Referring to Class Variables and Methods)

避免用一个对象访问一个类的静态变量和方法。应该用类名替代。例如:

  classMethod();             //OK
  AClass.classMethod();      //OK
  anObject.classMethod();    //AVOID!
 
3 常量(Constants)

位于for循环中作为计数器值的数字常量,除了-1,0和1之外,不应被直接写入代码。

4 变量赋值(Variable Assignments)

避免在一个语句中给多个变量赋相同的值。它很难读懂。例如:

  fooBar.fChar = barFoo.lchar = 'c'; // AVOID!
 
不要将赋值运算符用在容易与相等关系运算符混淆的地方。例如:

  if (c++ = d++) {        // AVOID! (Java disallows)
      ...
  }
 
应该写成

  if ((c++ = d++) != 0) {
    ...
  }
 
不要使用内嵌(embedded)赋值运算符试图提高运行时的效率,这是编译器的工作。例如:

  d = (a = b + c) + r;        // AVOID!
 
应该写成

  a = b + c;
  d = a + r;
 
5 其它惯例(Miscellaneous Practices)

5.1 圆括号(Parentheses)

一般而言,在含有多种运算符的表达式中使用圆括号来避免运算符优先级问题,是个好方法。即使运算符的优先级对你而言可能很清楚,但对其他人未必如此。你不能假设别的程序员和你一样清楚运算符的优先级。

  if (a == b && c == d)     // AVOID!
  if ((a == b) && (c == d))  // RIGHT
 
5.2 返回值(Returning Values)

设法让你的程序结构符合目的。例如:

  if (booleanExpression) {
      return true;
  } else {
      return false;
  }
 
应该代之以如下方法:

  return booleanExpression;
 
类似地:

  if (condition) {
      return x;
  }
  return y;
 
应该写做:

  return (condition ? x : y);
 
5.3 条件运算符"?"前的表达式(Expressions before '?' in the Conditional Operator)

如果一个包含二元运算符的表达式出现在三元运算符" ? : "的"?"之前,那么应该给表达式添上一对圆括号。例如:

  (x >= 0) ? x : -x;
 
5.4 特殊注释(Special Comments)

在注释中使用XXX来标识某些未实现(bogus)的但可以工作(works)的内容。用FIXME来标识某些假的和错误的内容。

转载自:http://www.huihoo.org/code/java_code_conventions.html#41
分享到:
评论

相关推荐

    java编程规范

    ### Java编程规范详解 #### 1. 引言 ##### 1.1 为何需要编码规范 在软件开发过程中,编码规范是确保代码质量和可维护性的关键因素之一。以下是几个重要的理由: - **软件维护成本**:软件生命周期中大约80%的成本...

    JAVA编码规范全集

    除了基本的编码规范外,还存在一些通用的编程惯例,有助于提升代码质量。 ##### 10.1 提供对实例以及类变量的访问控制 使用私有修饰符保护类变量,并提供公共的getter和setter方法。 ```java public class ...

    Java编程规范

    ### Java编程规范详解 #### 1. 为什么要有编码规范? 在软件开发过程中,编码规范起着至关重要的作用。根据Sun Microsystems(现为Oracle的一部分)的文档,编码规范的重要性主要体现在以下几个方面: - **提高...

    Java语言编码规范

    以上内容详细介绍了Java语言编码规范的各个方面,包括文件名、文件组织、缩进排版、注释、声明、语句、空白、命名规范、编程惯例等方面的具体规则。遵循这些规范不仅能够提高代码的质量和可读性,还能够促进团队间的...

    java代码编写规范

    #### 十、编程惯例 ##### 10.1 提供对实例以及类变量的访问控制 通过getter和setter方法提供对类成员变量的访问控制,保护类内部数据。 ##### 10.2 引用类变量和类方法 类变量和方法应使用静态修饰符static,以...

    Java学习笔记和例子

    Javabean是一种特殊的Java类,遵守特定的命名惯例和设计模式。Javabean的主要特点是所有的成员变量都是私有的,並使用setter和getter方法来访问这些变量。Javabean常用于封装数据,并提供了数据的 getter 和 setter ...

    Java编码规范[中文].

    编程惯例是一些被广泛接受的最佳实践,它们有助于提高代码质量和团队协作效率。 ##### 10.1 编程惯例规则 - **异常处理:** 正确地使用try-catch-finally结构来处理异常。 - **代码复用:** 尽量复用已有的代码,...

    Sun java编码规范(中文)

    Sun Microsystems发布的《Java编程语言编码规范》是一份重要的指导性文件,旨在帮助Java开发者们形成良好的编程习惯,提高代码的可读性和可维护性。这份规范从多个方面给出了具体的建议,包括文件名、代码组织结构、...

    Java编码规范

    #### 六、编程惯例 **6.1 提供对实例变量以及类变量的访问控制** 为了保护数据的安全性,应该使用private修饰符定义类的成员变量,并通过public方法(getter和setter)来访问这些成员变量。示例: ```java public ...

    java编码规范描述

    - `Main.java`: 主类,程序入口点。 - `Utils.java`: 工具类,用于存放公共方法。 - `Config.java`: 配置类,用于管理配置信息。 - `Model.java`: 数据模型类,用于表示数据结构。 - `Controller.java`: 控制器类,...

    java编码规范

    异常处理是Java编程的重要部分,try-catch语句用于捕获并处理可能发生的异常。 - 尽量具体地捕获异常类型,避免使用过于宽泛的异常类型。 - 在catch块中记录异常信息,并决定是否重新抛出异常。 #### 8. 空白 ...

    Java语言编码规范[含书签]

    Java程序使用特定的文件后缀,以区分不同的文件类型: - `.java`:Java源文件 - `.class`:编译后的Java字节码文件 ##### 2.2 常用文件名 在实际开发中,会有一些常见的文件名约定,比如: - `GNUmakefile`:用于...

    Java语言编码规范 中文翻译版

    编程惯例(Programming Practices) **10.1 提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables)** 实例变量应该设为私有(private),并通过getter和setter方法提供访问。 **10.2 ...

    Java™ Servlet 规范.

    其他的 Java 平台规范 .......................................................................................................................................3 其他重要参考资料 ............................

    Java语言编码规范.pdf

    编程惯例 (Programming Practices) ##### 10.1 提供对实例以及类变量的访问控制 (Providing Access to Instance and Class Variables) 提供对实例变量和类变量的访问控制是非常重要的。通常通过getter和setter...

Global site tag (gtag.js) - Google Analytics