java包名命名规范

做开发的都知道，一个好的项目规范可以提高开发效率以及后期的维护。自己手上有个项目，里面规范很乱，自己在对它进行二次开发的时候很蛋疼，它没有相应的文档，公司给我的就只有一个项目源码，其中的关系还要自己去做调试之后慢慢搞清楚。

今天学习了有关项目的规范教程就写了这边文章，请大家多多指教。

—-引用尚学堂的

以下是自己感觉比较好的文章就抄过来了：

一、命名规范

1、项目名全部小写

2、包名全部小写

3、类名首字母大写，一般都是使用驼峰式命名。

如：public class MyFirstClass{}

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

如：int index=0;

public void toString(){}

5、常量名全部大写

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

二、注释规范

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

6、项目分层命名

一般可以分为两种情况进行命名：

A、以功能模块来分层定义

比如，现有两个功能模块User、Menu

com.xxx.user.action com.xxx.menu.action

com.xxx.user.service com.xxx.menu.service

com.xxx.user.dao com.xxx.user.dao

com.xxx.user.controller com.xxx.user.controller

B、以逻辑模块来划分

com.xxx.action UserAction MenuAction

com.xxx.service UserService MenuService

转自：https://blog.csdn.net/u012486437/article/details/52013617

java包名命名规范相关推荐

java包名命名规范[【转】
indi : 个体项目,指个人发起,但非自己独自完成的项目,可公开或私有项目,copyright主要属于发起者. 包名为"indi.发起者名.项目名.模块名.--". per ...
java包名命名规则_告别编码5分钟，命名2小时！史上最全的Java命名规范参考！
简洁清爽的代码风格应该是大多数工程师所期待的.在工作中笔者常常因为起名字而纠结,命名已经成为我工作中的拦路虎,夸张点可以说是编程5分钟,命名两小时! 每个公司都有不同的标准,目的是为了保持统一,减少沟 ...
Java包的命名规范
参考了以下两篇博文: https://blog.csdn.net/kongjiea/article/details/45365753 https://blog.csdn.net/injoymario/ ...
java 项目名命名规范_javaWeb项目命名规范
标签: 一.项目结构这里和其他项目区别不大,我将模板抽离出来,更容易分析和理解: 解释一下:js主要包括extends(引入第三方的js).module(项目模块自己的js).lib(引用包,这里也 ...
java 包名、类名命名规则
代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯. 代码编写规范使用范围:J2EE项目开发. 包命名规范: 目的:包的命名规范应当体现出项目资源良好的划分 servl ...
java类的命名规范_浅谈Java中的命名规范
现代软件架构的复杂性需要协同开发完成,如何高效地协同呢? 答案是:制定一整套统一的规范. 无规矩不成方圆,无规范难以协同,比如,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全,试想如果没 ...
java包名和类名可以一样吗_Java入门第三课：Java基本语法
Java基础编写Java程序时,应注意以下几点: 1.大小写敏感: Java是大小写敏感的,这就意味着标识符Hello与hello是不同的.有些操作系统不区分大小写,不区分的话,文件名是不完全正确的 ...
java实体类命名规范_java实现周易起名-java实体类起名规范
Java中类的命名规范? java命名规范? Camel-Case(Camel-Case)是编写计算机程序时的一组命名规则(惯例). 程序员能够更轻松地与同行交流自己的代码,因此最好采用具有更好可读性 ...
程序员的职业道德：包的命名规范
变量命名相信许多的入坑小伙伴听得都不想再听了,注意是"再"而不是"在"(敲黑板!!!),那咱今天就从这命名规范来讲讲程序员的职业道德叭! 首先,我需要提到一位B ...

java包名命名规范

java包名命名规范相关推荐

最新文章

热门文章