精华内容
下载资源
问答
  • java命名规范
    2021-02-28 19:30:57

    一、命名规范

    1、 项目名全部小写

    2、 包名全部小写

    3、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。

    如:public class MyFirstClass{}

    4、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。

    如:int index=0;

    public void toString(){}

    5、 常量名全部大写

    如:public static final String GAME_COLOR=”RED”;

    6、所有命名规则必须遵循以下规则:

    1)、名称只能由字母、数字、下划线、$符号组成

    2)、不能以数字开头

    3)、名称不能使用JAVA中的关键字。

    4)、坚决不允许出现中文及拼音命名。

    二、注释规范

    1、   类注释

    在每个类前面必须加上类注释,注释模板如下:

    /**

    * Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.

    * FileName: Test.java

    * 类的详细说明

    *

    * @author 类创建者姓名

    * @Date    创建日期

    * @version 1.00

    */

    2、   属性注释

    在每个属性前面必须加上属性注释,注释模板如下:

    /** 提示信息 */

    private String strMsg = null;

    3、   方法注释

    在每个方法前面必须加上方法注释,注释模板如下:

    /**

    * 类方法的详细使用说明

    *

    * @param 参数1 参数1的使用说明

    * @return 返回结果的说明

    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

    */

    4、   构造方法注释

    在每个构造方法前面必须加上注释,注释模板如下:

    /**

    * 构造方法的详细使用说明

    *

    * @param 参数1 参数1的使用说明

    * @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明

    */

    5、   方法内部注释

    在方法内部使用单行或者多行注释,该注释根据实际情况添加。

    如://背景颜色

    Color bgColor = Color.RED

    更多相关内容
  • Java命名规范

    千次阅读 2022-02-16 20:53:58
    文章目录一、Java总体命名规范二、Java包名命名规范常规包名自定义包名 一、Java总体命名规范 1、项目名全部小写. 2、包名全部小写. 3、类名首字母大写,其余组成词首字母依次大写. 4、变量名,方法名首字母小写,如果...

    Java命名规范总则

    1. 名称只能由字母、数字、下划线、$符号组成
    2. 命名时不能以数字开头
    3. 在命名是绝对不能出现Java关键字
    4. 绝对不允许在命名时出现中文
    5. 尽可能的少用拼音性的命名

    1. 原因

      在我们在刚开始学习java的时候,给包、类、方法等命名的时候总是取名不规范,大多都是随便取的,对于一个专业的程序员来说。命名规范化也是必不可少的。命名规范的话能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。增加代码的易读性,可读性。

    2. 项目命名规范

    1. 最好用英文,所有单词全部用小写。如testjavaproject、studentmanagement等,
    2. 当然也也可以用中文,如“学生管理系统”等。

    3. 包命名规范

    1. 包名统一使用小写,点分隔符
    2. 最好统一使用单数形式。
    3. java包里面不能嵌套包,因为包和包是同级的,用包这个概念就是为了区分类。
    4. 所以为了表达嵌套关系,有了点分隔符
    5. 包名:全部小写字母,最好域名反过来写,不会冲突。如com.cnblogs.linking.myutil等

    4. 类命名规范

    1. 遵守驼峰命名法

      Java类名通常以大写字母开头,如果类名称由多个单词组成,则每个单词的首字母均应为大写。例如BinaryTree

    1. 缩写全部大写

      如果类名称中包含单词缩写,则这个所写词的每个字母均应大写。

    1. 采用名词

      由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。如:Person(词)Chinese(形容词)

    1. POJO类

      具有含义的名字,如果有多个单词,每个单词头字母大写。一般和数据库的表照应。例如:user_info表 则POJO类为UserInfo.

    1. 接口类

      以大写字母**"I"开头**。例如:IUserInfo

    1. 接口实现类

      实现的接口名称的首字母"I"去掉,以"Impl作为结尾",如果有多个单词,每个单词头字母大写。例如:UserInfoImpl

    5. 方法命名规范

    5.1 方法命名

    1. 首字母小写,其他单词首字母大写。如:getName()
    2. 使用完整的描述来准确描述方法名,看到方法名就该知道这个方法的功能。
    3. 尽量不去使用连接符 _
    4. 有返回值的方法,一般加前缀get。如:getName()
    5. 设置方法加前缀set。如setName()
    6. 布尔型判断方法一般以is为前缀。如isTrue()

    5.2 参数命名

    1. 使用有特定意义的词定义方法参数,如果可能的话使用与被赋值变量相同的名字。
    2. 如果参数需要区分和局部变量不重名的情况,则可以考虑加上Param。例如:userNameParam
    3. 首字母小写,其他单词首字母大写

    6. 变量命名

    6.1 普通变量(驼峰命名+前缀)

    1. 首字母小写,其他单词首字母大写
    2. 变量名要尽量简短,并且可以顾名思义,避免使用a,b,c等。
    3. 避免相似或只在大小写上有区别,例如:flag和Flag,避免同时使用。
    4. 循环计数变量使用i,j,k。
    5. 可以在变量名前加2到3个字母的前缀表示变量的数据类型。例如:intStudentAge或者studentAgeInt (表示int型)

    6.2 静态变量(全部大写,常加下划线)

    1. 全部大写,单词间用"_"连接,例如 static int THREAD_FLAG

    6.3 常量 (全部大写,常加下划线)

    1. 全部大写,单词间用"_"连接。
    2. 常量本身要用有意义的单词定义
    展开全文
  • 看到好多java开发规范手册都要10积分,资源是用来共享的,这个手册还行,给需要的人
  • java 命名规范

    2021-03-10 03:54:45
    但是由于Java面向对象编程的特性,每一名Java程序员都 可以编写属于自己的Java包,为了保障每个Java命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。 由于互联网上的域...

    定义规范的目的是为了使项目的代码样式统一,使程序有良好的可读性。

    包的命名  (全部小写,由域名定义)

    Java包的名字都是由小写单词组成。但是由于Java面向对象编程的特性,每一名Java程序员都 可以编写属于自己的Java包,为了保障每个Java包命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。 由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。

    例如:net.frontfree.javagroup

    类的命名 (单词首字母大写)

    根据约定,Java类名通常以大写字母开头,如果类名称由多个单词组成,则每个单词的首字母均应为大 写例如TestPage;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample,还有一点命名技巧就是由于类是设计用来 代表对象的,所以在命名类时应尽量选择名词。

    例如: Graphics

    方法的命名 (首字母小写,字母开头大写)

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

    例如:drawImage

    常量的命名 (全部大写 ,常加下划线)

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

    例如:MAX_VALUE

    参数的命名

    参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。

    Javadoc注释

    Java除了可以采用我们常见的注释方式之外,Java语言规范还定义了一种特殊的注释,也就是我们 所说的Javadoc注释,它是用来记录我们代码中的API的。Javadoc注释是一种多行注释,以/**开头,而以*/结束,注释可以包含一些 HTML标记符和专门的关键词。使用Javadoc 注释的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。

    例如:

    /**

    * This is an example of

    * Javadoc

    * @author darchon

    * @version 0.1, 10/11/2002

    */

    在每个程序的最开始部分,一般都用Javadoc注释对程序的总体描述以及版权信息,之后在主程序中 可以为每个类、接口、方法、字段添加 Javadoc注释,每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独占据一行以突出其概括作用,在这句话后面可以跟 随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落,例如上面例子中的@auther和@version,这 些段落将在生成文档中以特定方式显示。

    变量和常量命名

    变量的命名

    主要的的命名规范有以下三种:

    Camel 标记法:首字母是小写的,接下来的单词都以大写字母开头

    Pascal 标记法:首字母是大写的,接下来的单词都以大写字母开头

    匈牙利标记法:在以Pascal标记法的变量前附加小写序列说明该变量的类型

    在Java我们一般使用匈牙利标记法,基本结构为scope_typeVariableName,它 使用1-3字符前缀来表示数据类型,3个字符的前缀必须小写,前缀后面是由表意性强的一个单词或多个单词组成的名字,而且每个单词的首写字母大写,其它字 母小写,这样保证了对变量名能够进行正确的断句。例如,定义一个整形变量,用来记录文档数量:intDocCount,其中int表明数据类型,后面为表 意的英文名,每个单词首字母大写。这样,在一个变量名就可以反映出变量类型和变量所存储的值的意义两方面内容,这使得代码语句可读性强、更加容易理解。 byte、int、char、long、float、 double、boolean和short。

    数据类型/前缀(附)

    byte b

    char c

    short sh

    int i

    long l

    char c

    string s

    float f

    double d

    hashtable h

    [] arr

    List lst

    Vector v

    StringBuffer sb

    Boolean b

    Byte bt

    Map map

    Object ob

    对于在多个函数内都要使用的全局变量,在前面再增加“g_”。例如一个全局的字符串变量:g_strUserInfo。

    在变量命名时要注意以下几点:

    · 选择有意义的名字,注意每个单词首字母要大写。

    · 在一段函数中不使用同一个变量表示前后意义不同的两个数值。

    · i、j、k等只作为小型循环的循环索引变量。

    · 避免用Flag来命名状态变量。

    · 用Is来命名逻辑变量,如:blnFileIsFound。通过这种给布尔变量肯定形式的命名方式,使得其它开发人员能够更为清楚的理解布尔变量所代表的意义。

    · 如果需要的话,在变量最后附加计算限定词,如:curSalesSum。

    · 命名不相包含,curSales和curSalesSum。

    · static final 变量(常量)的名字应该都大写,并且指出完整含义。

    · 如果需要对变量名进行缩写时,一定要注意整个代码中缩写规则的一致性。例如,如果在代码的某些区域中使用intCnt,而在另一些区域中又使用intCount,就会给代码增加不必要的复杂性。建议变量名中尽量不要出现缩写。

    · 通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。例如,请使用 strCustomerFirst和strCustomerLast,而不要使用strFirstCustomer和strLastCustomer。常 用的量词后缀有:First(一组变量中的第一个)、Last(一组变量中的最后一个)、Next(一组变量中的下一个变量)、Prev(一组变量中的上 一个)、Cur(一组变量中的当前变量)。

    · 为每个变量选择最佳的数据类型,这样即能减少对内存的需求量,加快代码的执行速度,又会降低出错的可能性。用于变量的数据类型可能会影响该变量进行计算所产生的结果。在这种情况下,编译器不会产生运行期错误,它只是迫使该值符合数据类型的要求。这类问题极难查找。

    · 尽量缩小变量的作用域。如果变量的作用域大于它应有的范围,变量可继续存在,并且在不再需要该变量后的很长时间内仍然占用资源。它们的主要问题是,任何类 中的任何方法都能对它们进行修改,并且很难跟踪究竟是何处进行修改的。占用资源是作用域涉及的一个重要问题。对变量来说,尽量缩小作用域将会对应用程序的 可靠性产生巨大的影响。

    关于常量的命名方法,在JAVA代码中,无论什么时候,均提倡应用常量取代数字、固定字符串。也就是 说,程序中除0,1以外,尽量不应该出现其他数字。常量可以集中在程序开始部分定义或者更宽的作用域内,名字应该都使用大写字母,并且指出该常量完整含 义。如果一个常量名称由多个单词组成,则应该用下划线“_”来分割这些单词如:NUM_DAYS_IN_WEEK、MAX_VALUE。

    展开全文
  • java命名规范 一些规则java命名规范 一些规则java命名规范 一些规则java命名规范 一些规则
  • JAVA命名规范.pdf

    2021-09-30 17:27:55
    JAVA命名规范.pdf
  • 标识符的使用 标识符:凡是自己可以起名字的地方都是叫标识符 比如:类名、变量名、接口名、... Java中的命名规范: 如果没遵守,编译可以通过。但是会被同行鄙视建议遵守 包名:多单词组成时,所有字母都小写:...

    标识符的使用

    1.  标识符:凡是自己可以起名字的地方都是叫标识符
      1. 比如:类名、变量名、接口名、方法名、包名······
    2.  标识符的规则: 如果不遵守如下的规则,编译不通过!!需要严格遵守
      1. 由26个英文字母大小写,0-9数字,_ 或$组成
      2. 开头不可以用数字
      3. 不可以使用关键字和保留字,但可以包含关键字和保留字
      4. Java中严格区分大小写,长度不限制
      5. 标识符不能有空格
    3. Java中的命名规范:  如果没遵守,编译可以通过。但是会被同行鄙视建议遵守
      1. 包名:多单词组成时,所有字母都小写:        xxxyyyzzz
      2. 类名、接口名:多单词组成时,所有单子首字母大小:       XxxYyyZzz
      3. 变量名、方法名:多单词组成时,第一个单词全小写,第二个开始单词首字母大写:    xxxYyyZzz
      4. 常量名:所有字母都大写,多单词时单词之间用下划线链接:XXX_YYY_ZZZ

     注意:取名字为了提高阅读性,尽量要有意义“见名知意”

     

    展开全文
  • JAVA命名规范

    2021-02-28 12:27:56
    但是由于Java面向对象编程的特性,每一名Java程序员都 可以编写属于自己的Java包,为了保障每个Java命名的唯一性,在最新的Java编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。 由于互联网上的域...
  • java命名规范法则大全

    2021-09-03 17:16:58
    命名规范化也是必不可少的。命名规范的话能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。增加代码的易读性,可读性。 一、包(全部小写) 包名全部小写,但它不同的项目类型: 1.个体项目(indi )...
  • Java命名规范(建议收藏)

    千次阅读 2021-01-28 18:53:16
    一、 所有命名规范都必须遵循以下规则: 1、名称只能由字母、数字、下划线、$符号组成 2、不能以数字开头 3、名称不能使用JAVA中的关键字 4、坚决不允许出现中文及拼音命名 二、命名规范: 1、项目名称全部用...
  • 我们一起来看看,java命名规范是怎么定义呢?java命名规则和规范我们要如何理解?首先我们来看看包的命名规范:是由小写字母跟少量的数字组成的;java中自带的包是以 java. 和 javax 开头的,例如:java.awt;其他组织...
  • Java命名规则

    2019-04-02 21:10:48
    关于命名规则的一份文档,标识符命名法:标识符命名法最要有四种: 1 驼峰(Camel)命名法:又称小驼峰命名法,除首单词外。。。。。。
  • 主要介绍java关键字和java命名规范,主要介绍java关键字和java命名规范
  • 欢迎关注方志朋的博客,回复”666“获面试宝典在本文中,将从大到小,从外到内,总结Java编程中的命名规范。文中将会涉及到日常工作中常见的命名示例,如包命名,类命名,接口命名,方法命名,变...
  • 阿里巴巴Java开发命名规范

空空如也

空空如也

1 2 3 4 5 ... 20
收藏数 302,780
精华内容 121,112
关键字:

java命名规范

java 订阅
友情链接: GetCPUID.zip