项目开发中的编码规范

迈不过友情╰ 2024-02-17 14:38 38阅读 0赞

**1.规范存在的意义：**

好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护；

好的编码规范可以改善软件的可读性，可以让开发人员尽快而彻底地理解新的代码；好的编码规范可以最大限度的提高团队开发的合作效率；

长期的规范性编码还可以让开发人员养成好的编码习惯，甚至锻炼出更加严谨的思维；

**2.命名规范：**

尽量使用完整的英文描述符

采用适用于相关领域的术语

采用大小写混合使名字可读

尽量少用缩写，但如果用了，必须符合整个工程中的统一定义

避免使用长的名字（小于 15 个字母为正常选择）

避免使用类似的名字，或者仅仅是大小写不同的名字

避免使用下划线（除静态常量等）

所有Pojo类与数据库表名对应

所有Dao接口类继承自BaseDao，以I打头，以pojo类名称+Dao结束

所有Daoimpl实现类以pojo类名称+DaoImpl结束

所有业务接口类以I打头，以业务名称+Service结束

所有业务实现类：业务名称+Service；

**3.标识符类型说明：**

包（ Package ）的命名:

采用完整的英文描述符，都是由一个小写单词组成

类（ Class ）的命名:

类名应该是个一名词，采用大小写混合的方式，每个单词的首字母大写。尽量保证类名简洁而富于描述。使用完整单词，避免缩写词 ( 除非工程内有统一缩写规范或该缩写词被更广泛使用

接口（ Interface ）的命名:

基本与 Class 的命名规范类似。在满足 Classd 命名规则的基础之上，保证开头第一个字母为”I”，便于与普通的 Class区别开

枚举（ Enum ）的命名

异常（ Exception ）的命名

方法（ Method ）的命名

在service中，操作数据库更新、写入、删除，方法名以update、save、edit、add、move、delet、remove打头，保证spring事务托管的有效；对数据的查询采用 list、get、find打头；

一般方法遵循：

方法名是一个动词，采用大小写混合的方式，第一个单词的首字母小写，其后单词的首字母大写。方法名尽可能的描述出该方法的动作行为。返回类型为 Boolean 值的方法一般由“ is ”或“ has ”来开头例如：返回类型为 Boolean 值：用“ is ”或“ has ”来开头

得到某数据： get+ 数据描述名词复数 + 数据类型；

得到所有数据： get+All+ 数据描述名词复数 + 数据类型；

通过 XXX 得到 / 查询某数据： get/query+ 数据描述名词复数 + 数据类型 +By+ 条件；

添加某数据： save/add+ 数据描述名词 ()

更新某数据： save/update+ 数据描述名词；

删除某数据： delete/remove+ 数据描述名词；

参数（ Param ）的命名：

第一个单词的首字母小写，其后单词的首字母大写。参数量名不允许以下划线或美元符号开头，虽然这在语法上是允许的。参数名应简短且富于描述。

常量字段（ Constants ）的命名：

静态常量字段（ static final ）全部采用大写字母，单词之间用下划线分隔；

发表评论取消回复

表情：

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

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

相关阅读

相关 Java开发过程中易忽略的编码规范问题

在Java开发过程中，确实存在一些容易被忽视但又影响代码质量的编码规范问题。以下是几个常见的例子： 1. 格式化：代码格式混乱会影响阅读和理解。使用IDE如Eclipse或

古城微笑少年丶/ 2024年09月29日 19:21/ 0 赞/ 60 阅读

相关项目开发中的编码规范

1.规范存在的意义：好的编码规范可以尽可能的减少一个软件的维护成本 , 并且几乎没有任何一个软件，在其整个生命周期中，均由最初的开发人员来维护；好的编码规范可以改善软件

迈不过友情╰/ 2024年02月17日 14:38/ 0 赞/ 39 阅读

相关项目开发规范

开发规范 1.抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。

绝地灬酷狼/ 2023年10月16日 02:17/ 0 赞/ 44 阅读

相关项目开发规范

1. 分层思想 ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9

喜欢ヅ旅行/ 2023年10月03日 10:47/ 0 赞/ 8 阅读

相关不可小觑的Web开发编码规范

文章作者[Andrey Prikaznov][]在DZone上分享了关于Web开发里编码规范的注意事项。编码时间长的人总会遇到编码格式标准化的问题，但是不同的项目里需要使用不同

快来打我*/ 2022年09月17日 14:30/ 0 赞/ 155 阅读

相关前端开发规范之html编码规范

前端开发whqet,csdn,王海庆,whqet,前端开发专家前端开发规范系列文章之html编码规范，感兴趣的同学请关注《前端开发规范》专栏。随着html5的逐渐深入人心，

忘是亡心i/ 2022年08月06日 07:15/ 0 赞/ 242 阅读

相关前端开发规范之jQuery编码规范

前端开发whqet,csdn,王海庆,whqet,前端开发专家翻译自：[http://lab.abhinayrathore.com/][http_lab.abhinayra

缺乏、安全感/ 2022年08月06日 06:30/ 0 赞/ 223 阅读

相关 iOS开发编码规范建议

在开发过程中，我们不仅要去看别人的代码，也要让别人看我们的代码。那么，有一个良好的编码习惯将会非常重要。下面将会罗列使用[Objective-C][]来开发[iOS][]的编码

迷南。/ 2022年07月10日 13:58/ 0 赞/ 199 阅读

相关开发指南专题三：JEECG微云快速开发平台项目编码规范

开发指南专题三：JEECG微云快速开发平台项目编码规范 4. 项目编码规范 4.1. 项目编码规范 1. 项目编码格式为UTF-8(包括:java,jsp

ゞ浴缸里的玫瑰/ 2022年05月28日 13:54/ 0 赞/ 249 阅读

相关 laravel项目的开发规范

转载自：[https://learnku.com/docs/laravel-specification/5.5][https_learnku.com_docs_laravel-

ゞ浴缸里的玫瑰/ 2022年02月21日 16:16/ 0 赞/ 172 阅读