编程开发中的起名规范

混乱的workspace

工作一年当中接触到的都是别人写好的项目，很多时候就直接用了以前的项目名字，随着手里的项目越来越多，各种版本的项目用着相同的名字，根本记不住哪个项目是做什么的，一片混乱。这时候同事劝我整理一下项目吧，我才意识到这个问题。

修改项目名称

我做的项目中很多是一套项目改成各种版本给不同的公司用户使用，所以我试着用“客户公司名_项目名称“的方式来修改我的项目名称，这样一个系列的就会排列在一起方便查找，这是我目前能想的方法。下面是我修改完名字遇到的问题和解决方法：

1. 问题： 已经在使用的项目，修改名称后导致访问路径改变，不方便客户使用（因为能要求客户换成新的访问地址，还存在其他程序访问该程序时，路径改变还要修改程序重新上线）。
   解决： 1）本地启动的项目：修改项目配置，无论项目名称是什么，修改Context root 即可修改更改项目访问的url路径。
   
2. 解决： 1）打成war包上线的项目：修改war的名字即可，此时和Context root的名字已经无关了。

学习资料

虽然大学中学习过，但是很多都已经忘记了，下面是我在网上查找的命名规范，供自己学习使用：

1. 数据库命名设计规范：
   1）.数据库涉及字符规范

采用26个英文字母(区分大小写)和0-9这十个自然数,加上下划线’_'组成,共63个字符.不能出现其他字符(注释除外)。

注意事项:

1)以上命名都不得超过30个字符的系统限制.变量名的长度限制为29(不包括标识字符@)。

2)数据对象、变量的命名都采用英文字符,禁止使用中文命名.绝对不要在对象名的字符之间留空格.。

3)小心保留词,要保证你的字段名没有和保留词、数据库系统或者常用访问方法冲突 。

4)保持字段名和类型的一致性,在命名字段并为其指定数据类型的时候一定要保证一致性.假如数据类型在一个表里是整数,那在另一个表里可就别变成字符型了。

2.数据库命名规范

数据库直接使用应用或者系统命名.

比如:paper(论文系统)

备份数据库名使用正式库名加上备份时间组成,

paper_20070403

3.数据库表命名规范

数据表名使用小写英文以及下划线组成,尽量说明是那个应用或者系统在使用的.（便于区分不同一个项目使用同一个数据库中的表）

相关应用的数据表使用同一前缀,如论坛的表使用cdb_前缀,博客的数据表使用supe_前缀,前缀名称一般不超过5字

paper_user paper_group paper_userspace 

备份数据表名使用正式表名加上备份时间组成

paper_user_20070403

paper_group_20070403 

paper_userspace_20070403

4.字段命名规范

字段名称一般采用名词或动宾短语，且字段名为小写，数据库字段名全部采用小写英文单词，单词之间用“_”隔开，字段名根据实际意义命名，

注意事项：给所有字段名加注释

如：sex(性别)  is_good(是否优秀)

外键情况下采用 "表名_id“的方式，

如：user_id(关联用户表的id)

2. Java项目命名规范：
   一、命名规范
   1、 项目名全部小写

2、 包名全部小写

3、 类名首字母大写，如果类名由多个单词组成，每个单词的首字母都要大写。

public class MyFirstClass{}

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

int index=0;

public void toString(){}

5、 常量名全部大写

public static final String GAME_COLOR=”RED”;

6、所有命名规则必须遵循以下规则：

1)、名称只能由字母、数字、下划线、$符号组成

2)、不能以数字开头

3)、名称不能使用JAVA中的关键字。

4)、坚决不允许出现中文及拼音命名。

原文链接：https://blog.csdn.net/qq_30021219/article/details/79423124

二、注释规范

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

原文链接：https://www.php.cn/java-article-406664.html

2. Java包起名原则：
   indi ：
   个体项目，指个人发起，但非自己独自完成的项目，可公开或私有项目，copyright主要属于发起者。
   包名为“indi.发起者名.项目名.模块名.……”。

pers ：
个人项目，指个人发起，独自完成，可分享的项目，copyright主要属于个人。
包名为“pers.个人名.项目名.模块名.……”。

priv ：
私有项目，指个人发起，独自完成，非公开的私人使用的项目，copyright属于个人。
包名为“priv.个人名.项目名.模块名.……”。

onem ：
与“indi”相同，推荐使用“indi”。
另外，我为了区分团队项目和前面所说项目的区分，还有了一下扩展：

team ：
团队项目，指由团队发起，并由该团队开发的项目，copyright属于该团队所有。
包名为“team.团队名.项目名.模块名.……”。

com ：
公司项目，copyright由项目发起的公司所有。
包名为“com.公司名.项目名.模块名.……”。

java包各模块命名规则
action为控制层：有时也会命名为“controller”即MVC中充当C角色,用来分配哪个业务来处理用户请求。

biz业务层：存放好多处理业务的代码，现实中面向接口编程，一般这里定义都是业务接口，通常会有一个biz.impl这个包用来写实现类. 当然针对架构意义实现类不用说。

dao持久层：数据库操作都写在这里。

ui 用户交互层：通常为页面,例如.jsp,aspx等页面。

util功能包：针对本项目工具类。

common通用工具包：一般一个公司会有固定的jar，好几个项目通用的，例如远程调用等。

domian存放实体：通常一些对应数据表的实体类放在此，如果用Mybatis框架,一般mapping创建在它下面,当然只针对架构mapping也是无意义。

良好的命名规则能够让他人更容易熟悉项目。可以帮助自己快速回顾代码。好处多多。

原文链接：http://blog.csdn.net/Dave_CT/article/details/73394726