1. Package 的命名

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

    Class 的命名

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

    Class 变量的命名

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

    Static Final 变量的命名

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

  2. 参数的命名

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

      

    数组的命名

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

      byte[] buffer;

      而不是:

      byte buffer[];

      

    方法的参数

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

      SetCounter(int size){

      this.size = size;

      }

  3. Java 文件样式

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

      

    版权信息

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

      /**

      * Copyright ?0?3 2000 Shanghai XXX Co. Ltd.

      * All right reserved.

      */

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

  4. 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 的。

  5. 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 定义的成员变量如果名字含义明确的话,可以没有注释。

  6. 存取方法

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

      /**

      * 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; }

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

  7. 构造函数

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

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

      public

      CounterSet(int size){

      this.size = size;

      }

      

    克隆方法

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

      public

      Object clone() {

      try {

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

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

      obj.size = size;

      return obj;

      }catch(CloneNotSupportedException e) {

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

      }

      }

  8. 类方法

      下面开始写类的方法:

      /**

      * 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 www.gzlij.com 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);

      }

  9. toString 方法

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

      public

      String toString() {

      String retval = "CounterSet: ";

      for (int i = 0; i < data.length(); i++) {

      retval += data.bytes.toString();

      retval += data.packets.toString();

      }

      return retval;

      }

      }

      

    main 方法

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

Java学习之路(一) —— Java命名规范的更多相关文章

  1. java学习之路之javaSE基础1

    <h2>java学习之路之javaSE基础1</h2> <div> ###01.01_计算机基础知识(计算机概述)(了解)* A:什么是计算机?计算机在生活中的应用 ...

  2. Java学习之路(转)

    Java学习之路(书籍推荐)   一.基础类 1.<Thinking in java>(阅读2遍),入门第一位是建立正确的概念 2.<Core Java>这本书更贴近实践,更多 ...

  3. 新篇章之我的java学习之路下

    昨天写下了人生的第一篇博客,今天接着写我的java学习之路有关开发及框架的学习过程. 想要学好java语言,只学习一些java的基本语法对实际开发中的用处还是不大的,所以我们还要掌握一些有关javaW ...

  4. java学习之路之javaSE基础2

    java学习之路之javaSE基础2 所有的代码都是引用他人写的. 1.逻辑运算符 //&,|,^,! //int x = 10; //5 < x < 15 //x > 5 ...

  5. JAVA学习之路与大家分享

    这是我四年以前总结的JAVA学习之路,希望对初学者或想从事JAVA开发的人有帮助. 本人是软件工程专业出身,先后学过C.C++.JAVA.VB.delphi等等开发语言以及网络相关管理技术.哎,好久不 ...

  6. Java 学习之路 -- day00

    Java 学习之路 -- day00 Typora 快捷键操作 标题:#+空格 2. *斜体* 3. **加粗** 4. **斜体加粗*** 5. ~~删除线~~ 6. > 引用 7. ···分 ...

  7. Java学习之路:不走弯路,就是捷径

    1.如何学习程序设计? JAVA是一种平台,也是一种程序设计语言,如何学好程序设计不仅仅适用于JAVA,对C++等其他程序设计语言也一样管用.有编程高手认为,JAVA也好C也好没什么分别,拿来就用.为 ...

  8. 【分享】Java学习之路:不走弯路,就是捷径

    1.如何学习程序设计? JAVA是一种平台,也是一种程序设计语言,如何学好程序设计不仅仅适用于JAVA,对C++等其他程序设计语言也一样管用.有编程高手认为,JAVA也好C也好没什么分别,拿来就用.为 ...

  9. #Java学习之路——基础阶段(第一篇)

    我的学习阶段是跟着CZBK黑马的双源课程,学习目标以及博客是为了审查自己的学习情况,毕竟看一遍,敲一遍,和自己归纳总结一遍有着很大的区别,在此期间我会参杂Java疯狂讲义(第四版)里面的内容. 前言: ...

随机推荐

  1. php实现设计模式之 抽象工厂模式

    <?php /*抽象工厂模式:提供一个创建一系统相关或相互依赖对象的接口,而无需指定它们具体的类 * 创建型模式 */ //抽象小米工厂,能制造小米一,小米二 abstract class mi ...

  2. 【hihoCoder】1049.后序遍历

    问题:http://hihocoder.com/problemset/problem/1049?sid=767510 已知一棵二叉树的前序遍历及中序遍历结果,求后序遍历结果 思路: 前序:根-左子树- ...

  3. hihocoder #1058 Combination Lock

    传送门 时间限制:10000ms 单点时限:1000ms 内存限制:256MB 描述 Finally, you come to the interview room. You know that a ...

  4. DirSync: List of attributes that are synced by the Azure Active Directory Sync Tool

    http://social.technet.microsoft.com/wiki/contents/articles/19901.dirsync-list-of-attributes-that-are ...

  5. oracle个人总结

    oracle优化原则 1:insert 插入 (1):insert into /*+ append */ NOLOGGING 2: select 查询 (1):/*+ full(v) */ 全表查询 ...

  6. java UncaughtExceptionHandler 处理线程意外中止

    本文转自:http://peirenlei.iteye.com/blog/305079 Thread的run方法是不抛出任何检查型异常(checked exception)的,但是它自身却可能因为一个 ...

  7. 《使用shell位置变量进行目录文件的备份小脚本》

    今天才发现原来位置变量也可以玩的这么爽!! 这是使用位置变量进行文件目录备份:#!/bin/bashDATE=`date +%F`  //日期以年月日输出tar czf $1.$DATE.tar.gz ...

  8. ubuntu后台配置无线网络

    一.静态配置: 1.编辑 /etc/network/interfaces: auto loiface lo inet loopback auto wlan0iface wlan0 inet stati ...

  9. C#子窗口与父窗口交互(使用委托和事件)

    目标:在子窗口Form2上单击按钮时向Form1传递一组自定义参数,并显示在父窗口Form1上. 方法:有很多方法,这里只介绍委托和事件的实现方式. 思路:Form2中定义事件,Form1创建Form ...

  10. jQuery实现遮罩层

    1.1 背景半透明遮罩层样式 需要一个黑色(当然也可以其他)背景,且须设置为绝对定位,以下是项目中用到的css样式: /* 半透明的遮罩层 */ #overlay { background: #000 ...