公司代码规范模板参考

心已赠人 2023-02-14 01:19 58阅读 0赞

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

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

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

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

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

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

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

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

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

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

接口名-- 首字母大写

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvZGVyMTk5OA_size_16_color_FFFFFF_t_70]  
 数据库规范：

数据库命名-- 采用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注释

三： 实践部分

规范是已经给您了，您要按照上面的部分去完成，才行。没有实践，说再多也是没有用， 如果要您转载，请标明出处. 如果您觉得可以，请关注作者。 同时也可以加入 项目技术分享交流群 – 扣扣裙 前面6703中间040后面03 ，上面可以免费下载资料。发布您的问题， 进行相互交流学习.

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvZGVyMTk5OA_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200530094610467.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NvZGVyMTk5OA==,size_16,color_FFFFFF,t_70

发表评论取消回复

表情：

评论列表（有 0 条评论，58人围观）

还没有评论，来说两句吧...

相关阅读

相关前端代码规范（参考腾讯前端规范）

命名驼峰命名采用驼峰命名法 > 大驼峰命名：首字母大写 > 小驼峰命名：首字母小写文件资源命名 1. 文件名建议只用小写，不使用大写字母（为了提

r囧r小猫/ 2023年06月17日 14:53/ 0 赞/ 29 阅读

相关公司代码规范模板参考

一：为什么需要开发手册规范? 团队开发中，如果没有开发手册的约束，每个人可能都按照自己的想法去命名，去写代码。这样就会造成代码的可读性极差，后面维护代码的时候，会很

心已赠人/ 2023年02月14日 01:19/ 0 赞/ 59 阅读

相关 golang编码规范参考

格式化规范 go默认已经有了gofmt工具，但是我们强烈建议使用goimport工具，这个在gofmt的基础上增加了自动删除和引入包. go get golang.org

素颜马尾好姑娘i/ 2022年11月22日 12:38/ 0 赞/ 175 阅读

相关 Java命名规范参考

Java命名规范参考一、Java中的命名规范二、包命名三、类命名四、方法 4.1 返回真伪值的方法 4.2 用来

女爷i/ 2022年10月12日 15:54/ 0 赞/ 342 阅读

相关前端开发规范参考

前言：前端开发规范参考分享前端开发规范参考一、规范目的二、通用规范三、框架开发规范 1、项目使用框架 2、学习资料

秒速五厘米/ 2022年09月13日 04:14/ 0 赞/ 374 阅读

相关 android开发代码规范参考

我们在开发项目的时候对于刚刚入门的同学来说代码的规范程度直接就可以看出你的项目开发经验，为此希望大家在开发的时候越来越规范自己的代码，做一个合格的程序员，为你的梦想冲

冷不防/ 2022年08月27日 01:26/ 0 赞/ 193 阅读

相关 es6参考了Airbnb 公司的 JavaScript 风格规范

1.let 取代 var; 2.在let和const之间，建议优先使用const，尤其是在全局环境，不应该设置变量，只应设置常量; 3.静态字符串一律使用单引号或反引号

r囧r小猫/ 2022年05月30日 01:47/ 0 赞/ 187 阅读

相关归并排序代码模板(参考用)

class Vector { private: int size, length; int data, temp; void me

左手的ㄟ右手/ 2022年05月08日 06:36/ 0 赞/ 217 阅读

相关 C#编码规范参考

\[url\]https://www.cnblogs.com/wulinfeng/archive/2012/08/31/2664720.html\[/url\] \[url

素颜马尾好姑娘i/ 2022年04月06日 11:37/ 0 赞/ 226 阅读

相关总结Android规范(参考阿里规范, 仅用于公司内部)

前言一份合格的代码不应只满足于实现功能, 更应该遵循良好的规范. 遵循良好的代码规范有利于: 提升程序稳定性, 减少代码隐患, 降低故障率; 增强可扩展性

痛定思痛。/ 2021年11月09日 05:30/ 0 赞/ 314 阅读