`
a881127b
  • 浏览: 65938 次
  • 性别: Icon_minigender_1
  • 来自: 武汉
社区版块
存档分类
最新评论

java的命名规范(你绝不该忽视的规范)

阅读更多
所有的程序开发手册都包含了各种规则。一些习惯自由程序人员可能对这些规则很不适应,但是在多个开发人员共同写作的情况下,这些规则是必需的。这不仅仅是为了开发效率来考虑,而且也是为了后期维护考虑。

  命名规范

  定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失。(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)

  ● Package 的命名

  Package 的名字应该都是由一个小写单词组成。

  ● Class 的命名

  Class 的名字必须由大写字母开头而其他字母都小写的单词组成

  ● Class 变量的命名

  变量的名字必须用一个小写字母开头。后面的单词用大写字母开头。

  ● Static Final 变量的命名

  Static Final 变量的名字应该都大写,并且指出完整含义。

  ● 参数的命名

  参数的名字必须和变量的命名规范一致。

  ● 数组的命名

  数组应该总是用下面的方式来命名:

  byte[] buffer;

  而不是:

  byte buffer[];

  ● 方法的参数

  使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:

  SetCounter(int size){

  this.size = size;

  }

  Java文件样式

  所有的 Java(*.java) 文件都必须遵守如下的样式规则:

  ● 版权信息

  版权信息必须在 java 文件的开头,比如:

  /**

  * Copyright ?2000 Shanghai XXX Co. Ltd.

  * All right reserved.

  */

  其他不需要出现在 javadoc 的信息也可以包含在这里。

  ● Package/Imports

  package 行要在 import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列。如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理。

  package hotlava.net.stats;

  import java.io.*;

  import java.util.Observable;

  import hotlava.util.Application;

  这里 java.io.* 使用来代替InputStream and OutputStream 的。

  ● Class

  接下来的是类的注释,一般是用来解释类的。

  /**

  * A class representing a set of packet and byte counters

  * It is observable to allow it to be watched, but only

  * reports changes when the current set is complete

  */

  接下来是类定义,包含了在不同的行的 extends 和 implements :

  public class CounterSet

  extends Observable

  implements Cloneable

  ● Class Fields

  接下来是类的成员变量:

  /**

  * Packet counters

  */

  protected int[] packets;

  public 的成员变量必须生成文档(JavaDoc)。proceted、private和 package 定义的成员变量如果名字含义明确的话,可以没有注释。

  ● 存取方法

  接下来是类变量的存取的方法。它只是简单的用来将类的变量赋值获取值的话,可以简单的写在一行上。

  /**

  * Get the counters

  * @return an array containing the statistical data. This array has been

  * freshly allocated and can be modified by the caller.

  */

  public int[] getPackets() { return copyArray(packets, offset); }

  public int[] getBytes() { return copyArray(bytes, offset); }

  public int[] getPackets() { return packets; }

  public void setPackets(int[] packets) { this.packets = packets; }

  其它的方法不要写在一行上。

  ● 构造函数

  接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面)。

  访问类型 ("public", "private" 等.) 和 任何 "static", "final" 或 "synchronized" 应该在一行中,并且方法和参数另写一行,这样可以使方法和参数更易读。

  public

  CounterSet(int size){

  this.size = size;

  }

  ● 克隆方法

  如果这个类是可以被克隆的,那么下一步就是 clone 方法:

  public

  Object clone() {

  try {

  CounterSet bj = (CounterSet)super.clone();

  obj.packets = (int[])packets.clone();

  obj.size = size;

  return obj;

  }catch(CloneNotSupportedException e) {

  throw new InternalError("Unexpected CloneNotSUpportedException: " + e.getMessage());

  }

  }

  ● 类方法

  下面开始写类的方法:

  /**

  * Set the packet counters

  * (such as when restoring from a database)

  */

  protected final

  void setArray(int[] r1, int[] r2, int[] r3, int[] r4)

  throws IllegalArgumentException

  {

  //

  // Ensure the arrays are of equal size

  //

  if (r1.length != r2.length || r1.length != r3.length || r1.length != r4.length)

  throw new IllegalArgumentException("Arrays must be of the same size");

  System.arraycopy(r1, 0, r3, 0, r1.length);

  System.arraycopy(r2, 0, r4, 0, r1.length);

  }

  ● toString 方法

  无论如何,每一个类都应该定义 toString 方法:

  public

  String toString() {

  String retval = "CounterSet: ";

  for (int i = 0; i   retval += data.bytes.toString();

  retval += data.packets.toString();

  }

  return retval;

  }

  }

  ● main 方法

  如果main(String[]) 方法已经定义了,那么它应该写在类的底部。

  代码编写格式

  ● 代码样式

  代码应该用 unix 的格式,而不是 windows 的(比如:回车变成回车+换行) 。

  ● 文档化

  必须用 javadoc 来为类生成文档。不仅因为它是标准,这也是被各种 java 编译器都认可的方法。使用 @author 标记是不被推荐的,因为代码不应该是被个人拥有的。

  ● 缩进

  缩进应该是每行2个空格。不要在源文件中保存Tab字符。在使用不同的源代码管理工具时Tab字符将因为用户设置的不同而扩展为不同的宽度。

  如果你使用 UltrEdit 作为你的 Java 源代码编辑器的话,你可以通过如下操作来禁止保存Tab字符,方法是通过 UltrEdit中先设定 Tab 使用的长度室2个空格,然后用 Format|Tabs to Spaces 菜单将 Tab 转换为空格。

  ● 页宽

  页宽应该设置为80字符。源代码一般不会超过这个宽度,并导致无法完整显示,但这一设置也可以灵活调整。在任何情况下,超长的语句应该在一个逗号或者一个操作符后折行。一条语句折行后,应该比原来的语句再缩进2个字符。

  ● {} 对

  {} 中的语句应该单独作为一行。例如,下面的第1行是错误的第2行是正确的:

  if (i>0) { i ++ }; // 错误, { 和 } 在同一行

  if (i>0) {

  i ++

  }; // 正确, { 单独作为一行

  } 语句永远单独作为一行。

  如果 } 语句应该缩进到与其相对应的 { 那一行相对齐的位置。

  ● 括号

  左括号和后一个字符之间不应该出现空格,同样,右括号和前一个字符之间也不应该出现空格。下面的例子说明括号和空格的错误及正确使用:

  CallProc( AParameter ); // 错误

  CallProc(AParameter); // 正确

  不要在语句中使用无意义的括号。括号只应该为达到某种目的而出现在源代码中。下面的例子说明错误和正确的用法:

  if ((I) = 42) { // 错误 - 括号毫无意义

  if (I == 42) or (J == 42) then // 正确 - 的确需要括号

  程序编写规范

  ● exit()

  exit除了在main中可以被调用外,其他的地方不应该调用。因为这样做不给任何代码代码机会来截获退出。一个类似后台服务地程序不应该因为某一个库模块决定了要退出就退出。

  ● 异常

  申明的错误应该抛出一个RuntimeException或者派生的异常。

  顶层的main()函数应该截获所有的异常,并且打印(或者记录在日志中)在屏幕上。

  ● 垃圾收集

  JAVA使用成熟的后台垃圾收集技术来代替引用计数。但是这样会导致一个问题:你必须在使用完对象的实例以后进行清场工作。比如一个prel的程序员可能这么写:

  ...

  {

  FileOutputStream fos = new FileOutputStream(projectFile);

  project.save(fos, "IDE Project File");

  }

  ...

  除非输出流一出作用域就关闭,非引用计数的程序语言,比如JAVA,是不能自动完成变量的清场工作的。必须象下面一样写:

  FileOutputStream fos = new FileOutputStream(projectFile);

  project.save(fos, "IDE Project File");

  fos.close();

  ● Clone

  下面是一种有用的方法:

  implements Cloneable

  public

  Object clone()
分享到:
评论

相关推荐

    JAVA编程命名规范Java-开发命名规范

    该规范涵盖了JAVA中的各种命名规则,包括包命名、类命名、方法命名、参数命名、变量命名和常量命名等。 包命名规范: * JAVA包的名字都是由小写单词组成。 * 为了保障每个JAVA包命名的唯一性,在最新的JAVA编程...

    java命名规范java的命名规范java的命名规范java的命名规范

    Java编程语言的命名规范是确保代码可读性和可维护性的基石。遵循良好的命名习惯不仅可以提高代码的整洁性,还能让团队成员更容易理解代码的意图。以下是根据提供的信息详细阐述的Java命名规范: 1. **文件名与类名*...

    Java语言命名规范

    Java语言命名规范是Java编程中的一项基本规则,它旨在提高代码的可读性、可维护性和一致性。遵循这些规范对于任何Java开发者来说都是至关重要的,因为它使得团队成员能够更容易地理解彼此的代码,从而提高协作效率。...

    Java 开发命名规范

    "Java 开发命名规范" Java 开发命名规范是指在 Java 项目中对包名、类名、变量名等命名的规则和惯例,旨在确保代码的可读性、可维护性和重用性。本文将对 Java 开发命名规范进行详细的解释和说明。 一、包名命名...

    java开发命名规范

    ### Java开发命名规范详解 #### 一、概述 在Java软件开发过程中,遵循一套统一的命名规范至关重要。它不仅能够提高代码的可读性和可维护性,还能够增强团队协作效率。本文将根据提供的文件信息,详细介绍Java开发...

    java编程命名规范

    Java 编程命名规范 Java 编程命名规范是指在编写 Java 代码时,为了提高代码的可读性和维护性所需要遵守的一些规则和约定。这些规则涵盖了 Package 的命名、Class 的命名、Class 变量的命名、Static Final 变量的...

    java 命名规范

    在Java编程语言中,命名规范是非常重要的,它不仅关乎代码的可读性和可维护性,也是编程者之间交流思想的有效工具。以下是对Java命名规则的详细解读: 1. 类(Class)命名: Java类的命名应使用驼峰式命名法...

    java代码规范示例

    "java代码规范示例" Java 代码规范示例中,涵盖了 Java 项目中包、类、方法、注释等多个方面的规范。 首先,从文件头的注释部分可以看到,这个 Java 文件是一个 FTP 帮助类,负责实现 FTP 的上传和下载功能。这个...

    AndroidJava命名规范.doc

    在Android和Java开发中,遵循一致的命名规范是非常重要的,因为它可以提高代码的可读性和维护性。以下是一些关于Android和Java命名规范的关键点: 1. **包(packages)**: - 遵循反域名命名规则,如`...

    阿里Java的编码规范

    Java、编码规范、Java编码规范、阿里巴巴、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里...

    JAVA编程规范.pdf

    本文档提供了JAVA编程规范的详细说明,涵盖了类和方法的设计、编程原则、命名约定等方面的内容。 类和方法的设计 在设计类和方法时,需要遵守一些基本原则。首先,类应该具有强大的内聚力,即类中的方法应该紧密...

    java后端开发规范word文档

    这份"java后端开发规范word文档"包含了多个方面的内容,包括但不限于编程风格、命名规则、异常处理、并发控制、数据库操作、单元测试、日志记录以及代码组织结构等。 1. **编程风格**:编程风格是代码可读性的基础...

    Java代码规范.pdf

    Java代码规范文档中涉及的知识点涵盖了Java编程实践中的命名风格和代码组织方式,旨在为Java开发人员提供一份行业内部开发的准则,确保代码的可读性、一致性和维护性。以下是从提供的文档内容中提炼出的相关知识点:...

    阿里巴巴Java编程规范_阿里巴巴Java编程规范_

    《阿里巴巴Java编程规范》是阿里巴巴官方团队为了提升Java开发者代码质量与一致性,降低维护成本而制定的一套详尽的编程指南。这份规范不仅对新手有很好的引导作用,也为经验丰富的开发者提供了良好的编码习惯建议,...

    JAVA开发规范手册1.50

    JAVA开发规范手册1.50 本手册是阿里巴巴集团技术团队的集体智慧结晶和经验总结,旨在提高Java开发者的综合素质和软件开发质量。手册共分七个维度:编程规约、异常日志、单元测试、安全规约、MySQL数据库、工程结构...

    java好的命名规范

    Java编程语言的命名规范是确保代码清晰、可读性和易维护性的重要组成部分。遵循良好的命名规范可以帮助团队成员更快地理解代码,减少沟通成本,提高工作效率。以下是一些关键的Java命名规则: 1. **包(Package)...

    代码规范、命名、配置文件、Code+Review建议各类规范大全

    java、svn、mysql、dubbr、venus-common-monitor、venus-restful、公共码、日志、代码规范、命名、配置文件、Code+Review建议、postman等等等等;各类规范文档

    JAVA项目开发规范

    这份文档详细地阐述了JAVA项目中的各类命名规范、注释规范、项目文件夹组织规范以及排版规范,旨在提升软件的可读性、可重用性、健壮性、可移植性和可维护性。 ### 命名规范 #### 包命名规范 包命名应反映项目的...

    Java的Web命名规范例子

    在Java的Web开发中,命名规范是至关重要的,它不仅提高了代码的可读性,也有助于团队协作和项目的维护。下面将详细讲解Java Web命名规范的一些关键点,并结合给出的"weddingIndex"这个文件名,分析其可能遵循的规则...

Global site tag (gtag.js) - Google Analytics