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

。。。

可能写的不是很好，后期会继续完善

Java 项目的命名规范相关推荐

java 项目名命名规范_javaWeb项目命名规范
标签: 一.项目结构这里和其他项目区别不大,我将模板抽离出来,更容易分析和理解: 解释一下:js主要包括extends(引入第三方的js).module(项目模块自己的js).lib(引用包,这里也 ...
java类的命名规范_浅谈Java中的命名规范
现代软件架构的复杂性需要协同开发完成,如何高效地协同呢? 答案是:制定一整套统一的规范. 无规矩不成方圆,无规范难以协同,比如,制订交通法规表面上是要限制行车权,实际上是保障公众的人身安全,试想如果没 ...
iOS项目的命名规范
一.关于本文档 1.本文档的书写目的 <iOS项目的命名规范>的书写目的,在于让后续参加到该项目的iOS开发人员通过阅读该文档,了解在当前iOS项目的代码中的命名要求并严格按照本文 ...
java实体类命名规范_java实现周易起名-java实体类起名规范
Java中类的命名规范? java命名规范? Camel-Case(Camel-Case)是编写计算机程序时的一组命名规则(惯例). 程序员能够更轻松地与同行交流自己的代码,因此最好采用具有更好可读性 ...
Java开发项目的命名规范+命名方法+注释规范
一.命名规范变量Variable 变量名通常以小写字母 a-z 开头.如果变量名由多个单词构成,从第二个单词开始首字母需要大写 A-Z (小驼峰命名法).变量名中不建议使用下划线 _ 作为前缀或者单 ...
项目的命名规范，为以后的程序开发中养成良好的行为习惯
代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯. 代码编写规范使用范围:J2EE项目开发. 一.包命名规范: 目的:包的命名规范应当体现出项目资源良好的划分 1.s ...
java包名命名规范
做开发的都知道,一个好的项目规范可以提高开发效率以及后期的维护.自己手上有个项目,里面规范很乱,自己在对它进行二次开发的时候很蛋疼,它没有相应的文档,公司给我的就只有一个项目源码,其中的关系还要自己去 ...
JAVA基础（三）——服务器操作系统、Java开发环境、Java技术架构、定义Java类及其命名规范、Java注释方式
1. 服务器操作系统当前主流的服务器操作系统则主要分为:Windowsserver.UNIX.Linux.NetWare这四大阵容. (1)Windowsserver作为推广的最好,用户群体最大的服 ...
java语言中的标识符_Java语言基本语法（一）————关键字标识符（Java语言标识符命名规范Java语言的包名、类名、接口名、变量名、函数名、常量名命名规则）...
一.关键字关键字的定义和特点定义:被Java语言赋予特殊含义,用做专门用途的字符串(单词). 特点:关键字中所有字母均为小写下面列举一些常用的关键字. 用于定义数据类型的关键字:byte.sho ...

Java 项目的命名规范

Java 项目的命名规范相关推荐

最新文章

热门文章