Java编程规范

一、常见命名规则

(1)匈牙利命名法

比 较著名的命名规则是匈牙利命名法,但这种命名法对于跨平台移植简直是灾难。这种命名方法是由Microsoft程序员查尔斯·西蒙尼(Charles Simonyi) 提出的。其主要思想是“在变量和函数名中加入前缀以增进人们对程序的理解”。匈牙利命名法关键是:标识符的名字以一个或者多个小写字母开头作为前缀;前缀 之后的是首字母大写的一个单词或多个单词组合,该单词要指明变量的用途。例如:lpszStr, 表示指向一个以‘\0‘结尾的字符串(sz)的长指针(lp)变量。

(2)骆驼命名法

骆驼(Camel)命名法近年来越来越流行,在许多新的函数库和 Java这样的平台下使用得当相多。骆驼命名法,正如它的名称所表示的那样,指的是混合使用大小写字母来构成标识符的名字。其中第一个单词首字母小写,余 下的单词首字母大写。例如:printEmployeePaychecks(),函数名中每一个逻辑断点都有一个大写字母来标记。

(3)帕斯卡命名法

帕斯卡(Pascal)命名法与骆驼命名法类似。只不过骆驼命名法是第一个单词首字母小写,而帕斯卡命名法则是第一个单词首字母大写。例如:DisplayInfo()和UserName都是采用了帕斯卡命名法。
在C#中,以帕斯卡命名法和骆驼命名法居多。事实上,很多程序设计者在实际命名时会将骆驼命名法和帕斯卡结合使用,例如变量名采用骆驼命名法,而函数采用帕斯卡命名法。

(4)下划线命名法

下划线法是随着C语言的出现流行起来的,在UNIX/LIUNX这样的环境,以及GNU代码中使用非常普遍。
对于以上的几种命名规则,我们认为比较对变量或函数进行描述的是骆驼命名法和下划线命名法,因此,我们推荐使用这两种命名方面。

二、java命名风格

(1)包命名

包名按照域名的范围从大到小逐步列出,恰好和Internet上的域名命名规则相反。

由一组以“.”连接的标识符构成,通常第一个标识符为符合网络域名的两个或者三个英文小写字母。

package cn.edu.scau.mk.testdemo;

(2)类、接口命名(帕斯卡命名法)

类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如TestDemo;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLManager,还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。

public class TestDemo {

}

(3)方法名(驼峰命名法)

方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。可以为动词或动词+名词组合。

1、设置/获取某个值的Method,应该遵循setV/getV规范(V是变量名)

2、返回数组长度的Method,应该命名为length

3、返回集合长度的Method,应该命名为size

4、测试某个布尔值的Method,应该命名为isV

5、将对象转换为某个特定类型的Mehod应该命名为toT(T是类型名)

package cn.edu.scau.mk.testdemo;

import java.util.ArrayList;
import java.util.List;

/**
 *
 * @author MK
 */
public class TestDemo {
    private int key=0;
    private boolean finish=false;
    private int[] scores=new int[2];
    private List<String> names=new ArrayList<>();
    /**
     * @return the key
     */
    public int getKey() {
        return key;
    }

    /**
     * @param key the key to set
     */
    public void setKey(int key) {
        this.key = key;
    }

    /**
     * @return the finish
     */
    public boolean isFinish() {
        return finish;
    }

    /**
     * @param finish the finish to set
     */
    public void setFinish(boolean finish) {
        this.finish = finish;
    }

    public int length() {
        return scores.length;
    }

    public int size() {
        return names.size();
    }
}

(4)变量名(驼峰命名法)

普通变量命名应该采用首字母小写,其他字母首字母大写的方式。

public class TestDemo {
    private String personName;
}

(5)静态常量

final static变量的名字应该都大写,并且指出完整含义。如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词如。

public class TestDemo {
    static final String PERSON_NAME="Jack";
}

(6)逻辑变量

避免用flag来命名状态变量,用is来命名逻辑变量。

public class TestDemo {
    private boolean isFinish;
}

(7)数组

总是使用以下方式定义数组:

int[] arr = new int[10];

禁止使用C语言的是形式:

int arr[] = new int[2];

(8)泛型参数

Container中的Element应该用E表示;Map里的key用K表示,value用V;Type用T表示;异常用X表示

如果需要接收多个Type类型的参数,应该用邻接T的大写字母——例如S——来依次表示,当然也可以用T1, T2这样的方式

如果在范型方法存在于范型类中,应当尽量避免使用同样的Type Variable Names,以免混淆

publicclass HashSet<E> extends AbstractSet<E> {}

publicclass HashMap<K, V> extends AbstractMap<K, V> {}

publicclass ThreadLocal<T> {}

publicinterface Functor<T, X extends Throwable> {

    T val() throws X;
}

(9)推荐的命名

1.当要区别接口和实现类的时候,可以在类的后面加上“Impl”。

interface Container{
}

class ContainerImpl implements Container{
}

2.Exception类最好能用“Exception”做为类命名的结尾

class DataNotFoundException extends Exception{
}

class InvalidArgumentException extends Exception{
}

3..抽象类最好能用“Abstract”做为类命名的开头

abstract class AbstractBeanDefinition{
}

abstract class AbstractBeanFactory{

}

4. Test类最好能用“Test”做为类命名的结尾

class PersonTest {

}

5.简称与缩写(不推荐使用)

cp代表colorPoint

buf代表buffer

off代表offset

len代表length

除非是在循环中,否则一般不推荐使用单个字母作为变量名,不过也有例外,即约定俗成的单个字母

b代表byte

c代表char

d代表double

e代表Exception

f代表float

i, j, k代表整数

l代表long

o代表Object

s代表String

v代表某些类型的特定值
时间: 2024-10-07 15:45:13

Java编程规范的相关文章

Java编程规范实践

一个好的编程规范可以让代码易于理解,具体的操作却不必如此麻烦. 本文包含以下内容: Eclipse Java代码Formatter配置 Eclipse 代码模板配置 自动添加Javadoc注释 附录:常见Java编码规范 Java代码Formatter配置 在Eclipse中可以通过Code Format和Code Template配置方便地实现代码格式化和注释定制. 首先选择了一款喜欢的编码格式:Nutz Java 编码规范 (V1.0) 阅读完毕后,找到对应的eclipse code for

Java基础--Java编程规范

IsCoder 标记: Java基础,Java编程规范 摘要:Java虽然没有强制性的编程规范,但是为了便于统一,Java有不成文的编程规范,为了形成良好的编程习惯,建议熟悉并遵守Java编程规范,提高代码的阅读性. 一.Java标识符 在任何语言中,都要自己的一套标识符规则.Java的标识符包括:Java关键字.Java特殊功能的标识符.合法的用户自定义标识符.其中,我们能改变的只有自定义的标识符,和大部分计算机编程语言一样,Java标识符原始只支持ASCII的编码,但是随着Java在世界的影

java编程规范大全

JAVA编程规范大全 命名规范 定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失.(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性) Package 的命名 Package 的名字应该都是由一个小写单词组成. Class 的命名 Class 的名字必须由大写字母开头而其他字母都小写的单词组成 Class 变量的命名 变量的名字必须用一个小写字母开头.后面的单词用大写字母开头. Static Final 变量的命名 Static

谷歌Java编程规范

Google Java编程风格指南 January 20, 2014 作者:Hawstein 出处:http://hawstein.com/posts/google-java-style.html 声明:本文采用以下协议进行授权: 自由转载-非商用-非衍生-保持署名|Creative Commons BY-NC-ND 3.0 ,转载请注明作者及出处. 目录 前言 源文件基础 源文件结构 格式 命名约定 编程实践 Javadoc 后记 前言 这份文档是Google Java编程风格规范的完整定义.

[转] java编程规范

原文链接: 资料推荐--Google Java编码规范 之前已经推荐过Google的Java编码规范英文版了: http://google-styleguide.googlecode.com/svn/trunk/javaguide.html 虽然这篇文章的英文很简单,但是最近发现有人翻译了这篇文章,所以专门写一篇文章推荐一下: http://hawstein.com/posts/google-java-style.html 同时为了避免原始文章丢失,所以转了一下: 作者:Hawstein出处:h

Java编程规范总结

代码总体原则 1.1 Java编程遵循的通用原则: 清晰第一.易于维护.易于重构. 简洁为美.易于理解.易于实现. 选择合适的风格,团队保持一致. 1.2 还需要注意一下方面: 面向对象编程隐藏了很多内部实现细节,使用许多JAVA特性时,要注意正确使用.比如:多线程并发.泛型.装箱数据类型.异常处理.对象克隆等. 2. 代码风格 原则1:命名原则:为包.类.方法.变量取一个好名字,使代码易于理解. 原则2:禁止使用魔鬼数字 不要直接使用数字,应采用有意义的静态变量或枚举来代替. 原则3:常量命名

Java 编程规范

一.   编码规范的意义 应用编码规范对于软件本身和软件开发人员而言尤为重要,有以下几个原因: 1)好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护: 2)好的编码规范可以改善软件的可读性,可以让开发人员尽快而彻底地理解新的代码: 3)好的编码规范可以最大限度的提高团队开发的合作效率: 4)长期的规范性编码还可以让开发人员养成好的编码习惯,甚至锻炼出更加严谨的思维: 二.具体命名规范 1.标识符的意义 1)尽量使用完整的英

JAVA编程规范-OOP规范

1.[强制]避免通过一个类的对象引用访问此类的静态变量或静态方法,无谓增加编译器解析成本,直接用类名来访问即可. 2.[强制]所有的覆写方法,必须加@Override注解.反例:getObject()与 get0bject()的问题.一个是字母的 O,一个是数字的 0,加@Override可以准确判断是否覆盖成功.另外,如果在抽象类中对方法签名进行修改,其实现类会马上编译报错. 3.[强制]相同参数类型,相同业务含义,才可以使用 Java的可变参数,避免使用 Object.说明:可变参数必须放置

IDEA集成java编程规范插件

第一种:如图所示搜索 Alibaba Java Coding Guidelines(阿里巴巴) 安装完成后,重启idea,点击tools>阿里巴巴编程>编程规约扫描 即可 原文地址:https://www.cnblogs.com/dqcer/p/9123373.html