Java之路——Java中的命名规范

最新推荐文章于 2024-09-25 10:59:43 发布

king_1421484363

最新推荐文章于 2024-09-25 10:59:43 发布

阅读量259

点赞数

分类专栏： Java成长日记文章标签： java

本文链接：https://blog.csdn.net/king_1421484363/article/details/54897818

版权

Java成长日记专栏收录该内容

1 篇文章 0 订阅

订阅专栏

前言：作为刚接触Java的一名菜鸟，就我个人而言对Java中的一些概念的理解还不是很深刻，但是在最近做项目的工程中遇到的关键性错误都是命名不规范，特此整理，加深印象！！

使用前注意事项：

1.由于Java面向对象编程的特性，在命名时应尽量选择名词。

2.驼峰命名法（Camel-Case）: 当变量名或函式名是由一个或多个单字连结在一起，而构成的唯一识别字时，首字母以小写开头，每个单词首字母大写（第一个单词除外），如：myFirstName。

Java中的命名规范：

1.项目名称书写规范:项目名称全部小写

2.包名书写规范（Package）:推荐使用公司或机构的顶级域名为包名的前缀，目的是保证各公司/机构内所使用的包名的唯一性。包名全部为小写字母，且具有实际的区分意义。

实际应用：应用系统中经常应用分层，Dao层（数据库访问）、Service层（业务处理）、Web层（页面控制action类）。

（1）包名的前几个为固定名称, 如果是网站的话，采用网站的域名的反写，如果域名还没有确定的话，采用公司固定的几个名称。如：net.vschool

（2）在包名的接下来一个单词为模块的名称。如：用户模块，包名为net.vschool.user。

（3）关于模块的访问操作，采用分层形式,一般分为：

Dao层操作：一般定义在net.vschool.xxx.dao 中，其中xxx为模块名称，如net.vschool.user.dao。

Service层操作：一般定义在net.vschool.xxx.servie中，如net.vschool.user.service。

web层操作：一般定义在 net.vschool.xxx.action中，如net.vschool.user.action。

3.类的命名规范：参照驼峰命名法，类名的首字母大写，如果类名由多个单词组成，每个单词的首字母都要大写。（1）示例：StudentAnswer.java

（2）当要区别接口类和实现类的时候，可以在类的后面加上“Impl”，如：接口类：UserInterface.java 接口实现类：UserInterfaceImp

（3）推荐实体类没有后缀名。

实际应用：应用系统中经常应用分层，Dao层（数据库访问）、Service层（业务处理）、Web层（页面控制action类），每一层的类的名称尽量带上该层后缀。

①Dao层：

a、接口类：采用JavaBean+Interface+Dao的形式来定义,即，实体对象+Interface+Dao。如：用户对象接口类： UserInterfaceDao。

b、实现类：采用JavaBean+Interface+Impl+Dao的形式来定义,即，实体对象+Interface+Impl+Dao。如：用户对象实现类：UserInterfaceImplDao。

②Service层：

a、接口类：采用Xxx+Interface+Service的形式来定义,即，模块+Interface+Service。如：用户管理接口类：UserMsgInterfaceService。

b、实现类：采用Xxx+Interface+Impl+Service的形式来定义,即，模块+Interface+Impl+Service。如：用户管理实现类：UserMsgInterfaceImplService。

③Web层（action类）：

a、实现类：采用xxx+Operator+Action的形式来定义,即，模块+操作+Action。如用户模块User+删除操作Delete+Action = UserDeleteAction。

4.变量名，方法名，参数名的首字母小写，如果名称是由多个单词组成，每个单词的首字母都要大写（第一个单词除外）。例如int index=0;public void toString{};

5.常量名全部大写如public static final String GAME_COLOR="RED";

6.Javadoc注释：

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

例如：

/**
*This is an example of
*Javadoc
*@author king
*@version 0.1, 10/11/2002
 */

在每个程序的最开始部分，一般都用Javadoc注释对程序的总体描述以及版权信息，之后在主程序中可以为每个类、接口、方法、字段添加 Javadoc注释，每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能，这句话应单独占据一行以突出其概括作用，在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以Javadoc注释标签开头的特殊段落，例如上面例子中的@auther和@version，这些段落将在生成文档中以特定方式显示。
7.所有命名规则必须遵循易以下规则：
（1）名称只能由字母、数字、下划线、$符号组成
（2）不能以数字开头
（3）名称不能使用Java中的关键字
（4）坚决不允许出现中文及拼音命名