java编程规范之java命名规范

摘要:
如果你想成为一名优秀的程序员,你必须首先培养良好的编程习惯。为了提高代码的可读性,必须有良好的命名约定。java命名约定:项目名称:1:有些人使用缩写,然后全部大写;2: 有些人使用首字母缩略词大写+驼峰命名方法包名:[全部小写,以域名开头]1:包名全部小写;2: 包的第一部分通常是顶级域名之一,如com、edu、gov、mil、net和org。后续部分由每个组织的内部命名规则决定。内部命名规则指定每个组件的目录名、部门名称和项目名称。

想要成为一个优秀的程序员,首先要培养良好的编程习惯,为了提高代码的可读性,必须有好的命名规范。
这篇文章是小编结合网上的很多资料整理出来的,若有不当或错误的地方,欢迎大家指正

在文章开始前,为方便阅读,先简单介绍一点知识
驼峰命名法:驼峰命名法就是当变量名或函数名是由一个或多个单字连结在一起,而构成的一识别字时,第一个单字以小写字母开始,第  二个单字的首字母大写或每一个单字 的首字母都采用大写字母例如:myFirstProject。

java命名规范:

项目名
          1:一部分人采用简写,然后全部大写;
           2:一部分人使用首字母大写+驼峰命名法

包名:[全部小写,域名起头]
      1:包名全部小写;
      2:Package第一部分通常是顶级域名之一,如com、edu、gov、mil、net、org,后续部分由各组织内部命名规则决定,内部命名规则 指定了各组件的目录名,所属部名    

          项目名等。例如:com.frontfree.javagroup;
      3:关于j2ee中包的命名习惯,我在网上看到一篇博客,很详细的汇总了j2中各个方面包的命名规范,给大家个网址:                

         http://blog.csdn.net/yilvqingtai/article/details/7989618

类名:[首字母大写+驼峰命名法]
        根据约定,Java类名通常以大写字母开头,如果类名称由多个单词组成,则每个单词的首字母均应为大 写例如TestDemo;如果类名称中  包含单词缩写,则这个所写词

        的每个字母均应大写,例如DOMDemo。

接口:[首字母大写+驼峰命名法]
        1:接口名的命名规范与类名一致;
        2:使用完整的英文描述命名接口。

方法:[驼峰命名+顾名思义]
       1:首字母小写,其他单词首字母大写,如:getName();
       2: 使用完整的描述来准确描述方法名,看到方法名就该知道这个方法的功能,例如:getNameByIdFromDB() 一看就知道是通过id   从数据库中获取name,虽然有点长,但 对后期理解和维护提供了极大方便,当然,为了防止代码冗长,还是应该尽量缩短名称长度,可以使用缩写的地方尽量使用缩写;
       3:方法名应该是一个动词+名词,例如getName();
      4: 前缀问题
           I:类的获取方法(有返回值的方法)的方法名一般加前缀get,如:getRootNode();
           II:类的布尔型判断方法一般以is为前缀,如isEmopty();
          III:类的设置方法加前缀set,如setName();
          IV:一般方法,使用完整的英文描述说明方法功能,以单词开头,如:openFile();

方法的参数
        1:使用有特定意义的词定义方法参数,如果可能的话使用与被赋值变量相同的名字;
        2;首字母小写,其他单词首字母大写

普通变量:[驼峰命名+顾名思义+前缀]
      1:采用驼峰命名;
      2:变量名要尽量简短,并且可以顾名思义,避免使用a,b,c等;
      3:避免相似或只在大小写上有区别,例如:flag和Flag,避免同时使用;
      4: 循环计数变量使用i,j,k
      5:前缀问题:
            I:可以在变量名前加2到3个字母的前缀表示变量的数据类型,例如:strClassName(以此表示String型)、intStudentAge(表示int型)等等;
           II:可以通过加前缀区分全局变量和局部变量,用g_表示全局变量,如g_strClassName。鉴 于全局变量难以维护,应该尽少全局变量的使用。
     6:后缀问题:
          I:为了创建统一的变量,通常在变量名后加一个量词后缀,例如strStudentFirst,strStudentLast,而不要使用strFirstStudent
            常用的量词后缀有First,Next,Prev,Last,Cur(一组变量中的当前变量)     

静态变量:[全部大写,常加下划线]
      1:全部大写,单词间用"_"连接,例如 static int THREAD_FLAG
      2:其他规则参照普通变量的规则2,3,5,6

常量:[全部大写,常加下划线]
      1:全部大写,单词间用"_"连接;
      2:常量本身要用有意义的单词定义;
   
xml
     1:xml文件名全小写;  

jsp/js等普通文件
     1:与class命名规则一致;


 

免责声明:文章转载自《java编程规范之java命名规范》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇sysctl.Net Core 商城微服务项目系列(十三):搭建Log4net+ELK+Kafka日志框架下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

Scala学习3——注释和变量类型

1.注释 Scala注释和java完全一致 // 单行 /* */ 多行 /** */ 文档,方法或者类前面,便于scaladoc生成文档。 //单行注释 /* 多行注释 */ /* * 文档注释 * * * */ 2.代码规范 使用tab操作实现缩进,默认整体向右移动;shift+tab整体左移 使用...

UnityEditor研究学习之EditorWindow

在unity使用过程中,其实我们都是在各个不同功能的Window下工作。 比如在Scene窗口中操作物体,在Inspector中操作物体属性,在Game视窗中观察游戏状态。 所以窗口是Unity的灵魂,这是唯一接口我们能够通过它来制作游戏。 那么,我们想自定义一个自己的窗口,那该如何呢?今天我们就来学习下EditorWindow,由于这个类在UnityE...

php 4种传值方式

我们定义page01.php和page02.php两个php文件,将page01中的内容想办法传递到page02,然后供我们继续使用。第一种:     使用客户端浏览器的cookie。cookie很容易理解,就是一个临时文件,可以把它看成一个储藏室,浏览器在浏览的过程中记录一些信息,就暂时存放在这里。在page01中设置一个cookie。 代码如下: &...

C# new和初始化

虽然知道使用new可以创建对象,但一直不是很理解初始化和new等知识的具体。 通过8个问题和需求,了解相关知识。 了解问题和需求 1.new 的三个步骤 2.初始化是什么意思。 3.变量声明后和变量赋值为null或变量调用了new的区别。 4.字段不是变量。 一、new的三个步骤: 1 在栈或者堆中开辟空间,空间的大小由类决定,进行内存空间指向。 2 在开...

AI学习---基于TensorFlow的案例[实现线性回归的训练]

线性回归原理复习         1)构建模型               |_> y = w1x1 + w2x2 + …… + wnxn + b        2)构造损失函数               |_> 均方误差        3)优化损失               |_> 梯度下降 实现线性回归的训练         准...

influxDB在grafana中使用

Using InfluxDB in Grafana,influxDB在grafana中使用 grafana带有功能丰富的数据源插件influxDB。支持丰富的查询编辑器、注释和templating(模版)查询。 增加数据源(Adding the data source)  点击顶部Grafana图标打开侧边的菜单。 在 Dashboards链接下的侧菜单...