企业开发手册规范参考

一： 为什么需要开发手册规范?

  

       团队开发中，如果没有开发手册的约束，每个人可能都按照自己的想法去命名，去写代码。这样就会造成

代码的可读性极差，后面维护代码的时候，会很痛苦，会浪费很多很多时间 ，所以 团队开发中，必须需要开发规范。

 

二 : 那写的代码怎么才能符合要求呢?

 

      当然每个公司都有自己的规范，自己的约束，比如 阿里有 ，京东有 ，字节跳动有，包括您自己服务公司都有。但是很多原则是有共性的。

比如 类名--首字母必须大写 ，你如果写一个小写的，可能在公司里面直接扣您绩效。

类名 --必须见闻知意，不要定义 a b c这种名字 比如 OrderServiceImpl.java

方法名 --首字母小写，其他单词首字母大写 比如 addProduct()

包名--全部小写 ，比如 com.xxx.service/com.xxx.mapper等

变量名 -- 和方法名规则一样

接口名-- 首字母大写

 

 

数据库规范：

 

数据库命名-- 采用26个英文字母，不要出现汉字 命名尽量通俗易懂 不要超过30个字符

数据表命名-- 普通表 t表名 比如 t_user t_test 系统表 sys表名

数据库视图命名-- v_视图名 比如 v_reports

数据库存储过程命名-- pro_存储过器名

数据库触发器命名 -- tri_触发器名

索引名命名 -- table_col_index

 

项目规程规范:

 

采用分层结构书写，比如

公司域名倒着写.项目名.层次名

比如：

com.xxx.pgms.dto --数据传输对象

com.xxx.pgms.query -- 数据查询对象

com.xxx.pgms.service --数据业务层

com.xxx.pgms.mapper --数据持久层

com.xxx.pgms.web --数据web层

com.xxx.pgms.web.controller -- 视图控制层

com.xxx.pgms.web.filter --过滤器

com.xxx.pgms.util -- 工具类

com.xxx.pgms.config --配置类

 

注释规范：

 

java代码注释

单行注释 //

多行注释 /***/

 

html xml注释

<!-- 注释内容 -->

 

三： 实践部分

规范是已经给您了，您要按照上面的部分去完成，才行。如果要转载，请标明出处.