命名规 Java 命名规范 (1) 如果不是必要,代码中只能出现英文字母. (2) Package 的命名 Package 的名字应该都是由小写单词组成,格式为 org.项目名称.,比如 myboss 的包写为 org.myboss.*; (3) Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成,例如 Class Main(){} (4) Class 变量的命名 变量的名字必须用一个小写字母开头.后面的单词可以用大写字母开头. 例如 Main main = new Mail(); (5) Static Final 变量的命名 Static Final 变量的名字应该都大写,并且以_开头,并且指出完整含义,例如 public static final int _STOPPED = 0; (6) 参数的命名 参数的名字必须和变量的命名规范一致. 数组的命名 数组应该总是用下面的方式来命名: byte[] buffer; 而不是: byte buffer[]; (7) 方法的参数 使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字,方法名字第一个字母小写. setCounter(int size){ this.size = size; } (8) Java 文件样式 所有的
Java(*.java) 文件都必须遵守如下的样式规则 版权信息
版权信息必须在 java 文件的开头,比如: /** * Redistribution and use of this software and associated documentation * ("Software"), with or without modification, are permitted provided * that the following conditions are met: * * 1. Redistributions of source code must retain copyright * statements and notices. Redistributions must also contain a * copy of this document. * * 2 . Due credit should be given to the Jetwebs.org * * * THIS SOFTWARE IS PROVIDED BY Jet
webs.org AND CONTRIBUTORS * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL * JETWEBS.ORG OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, * Copyright 2009 (C) Jetwebs.org. All Rights Reserved. * * $Id: Main.java,v 1.0 2009/11/24 08:40:32 jeff Exp $ * * Date Author Changes * 11/20/2008 jeff created * 11/26/2008 jeff Formated */ 其他不需要出现在 javadoc 的信息也可以包含在这里. 其中在末尾部分是本文件信息,包括 $Id,历史改动纪录.
(9) 代码顺序: Package/Imports package 行要在 import 行之前,空一行,import 中标准的包名要在本地的包名之前,而且按照字母顺序排列.如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理. ア) package org.myboss; イ) import java.io.*; import java.net.URL; import javax.management.MBeanException; ウ) 接下来的是类 Class 的注释,一般是用来解释类的. エ) 接下来是类定义,包含了在不同的行的 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; } 其它的方法不要写在一行上
(10) 构造函数 接下来是构造函数,它应该用递增的方式写(比如:参数多的写在后面). 访问类型 ("public", "private" 等.) 和 任何 "static", "final" 或 "synchr