书写格式问题

我的文章命名是为了更好分清楚学习的模块，所以有的用的中文，希望不会被感染！！！为了更好分清楚学习的模块！为了更好分清楚学习的模块！为了更好分清楚学习的模块！重要的话说三遍！！现实不要这么写

一个好的项目规范可以提高开发效率以及后期的维护。自己手上有个项目，里面规范很乱，自己在对它进行二次开发的时候很蛋疼

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

一、命名规范

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