TreeMind树图在线AI思维导图
当前位置:树图思维导图模板IT互联网分析方法/模型代码规范思维导图

代码规范思维导图

  收藏
  分享
免费下载
免费使用文件
原来是y 浏览量:142022-09-15 11:24:10
已被使用3次
查看详情代码规范思维导图

本思维导图总结交互规范知识点代码规范

树图思维导图提供 代码规范思维导图 在线思维导图免费制作,点击“编辑”按钮,可对 代码规范思维导图  进行在线思维导图编辑,本思维导图属于思维导图模板主题,文件编号是:30327a5cbcfd63067562a6027f2aa2d8

思维导图大纲

代码规范思维导图模板大纲

⼀、编程规约

1、⼀些命名的风格必须是不能随着⾃⼰的个性⽽来的,必须强制;

2、常量的定义,也要有⼀些规范,常量主要注意有⼀定的范围使⽤;

3、代码格式,

主要就是改写的⼀定要写,⽽且要注意我们都知道⽽⼜不喜欢做的,⽐如缩进,空格,写注释之类的;

4、必须要写注释,注释也要有⼀定的规范

所有的类都必须添加创建者和创建⽇期,这是最起码的对代码的记录;

代码修改的同时,注释也要进⾏相应的修改,尤其是参数、返回值、异常、核⼼逻辑等的修改;

特殊注释标记,请注明标记⼈与标记时间。

注意及时处理这些标记,通过标记扫描,经常清理此类标记。

5、OOP规约,举⼀些简单常⽤的规范

所有的覆写⽅法,必须加@Override注解;

相同参数类型,相同业务含义,才可以使⽤ Java的可变参数,避免使⽤ Object;

避免通过⼀个类的对象引⽤访问此类的静态变量或静态⽅法,⽆谓增加编译器解析成本,直接⽤类名来访问即可

所有整型包装类对象之间值的⽐较,全部使⽤equals⽅法⽐较;慎⽤ Object的 clone⽅法来拷贝对象

任何类、⽅法、参数、变量,严控访问范围。

6、集合处理,集合初始化时,指定集合初始值⼤⼩

在使⽤Collection 接⼝任何实现类的addAll()⽅法时,都要对输⼊的集合参数进⾏NPE判断。

7、控制语句

当switch 括号内的变量类型为String并且此变量为外部参数时,必须先进⾏null 判断;表达异常的分⽀时,少⽤ if-else ⽅式,不要在其它表达式(尤其是条件表达式)中,插⼊赋值语句。

⼆、异常⽇志

1、对于异常处理,不要⽤来做流程控制,条件控制

避免出现重复的代码(少复制粘贴⾃⼰的代码)

⽅法的返回值可以为 null,不强制返回空集合,或者空对象等,必须添加注释充分说明什么情况下会返回 null值。

2、所有⽇志⽂件⾄少保存15天,⽹络⽇志最少6个⽉

尽量⽤英⽂来描述⽇志错误信息,如果⽇志中的错误信息⽤英⽂描述不清楚的话使⽤中⽂描述即可,否则容易产⽣歧义(个⼈⽐较推荐中⽂,因为我们是中国⼈)。

三、单元测试

好的单元测试必须遵守 AIR原则,具有有⾃动化、独⽴性、可重复执⾏的特点;单元测试是可以重复执⾏的,不能受到外界环境的影响。说明:单元测试通常会被放到持续集成中,每次有代码 check in 时单元测试都会被执⾏;单元测试代码必须写在如下⼯程⽬录:

src/test/java,不允许写在业务代码⽬录下;单元测试的基本⽬标:语句覆盖率达到 70%;核⼼模块的语句覆盖率和分⽀覆盖率都要达到100% 。

四、安全规约

安全为主,⾪属于⽤户个⼈的页⾯或者功能必须进⾏权限控制校验

禁⽌向 HTML页⾯输出未经安全过滤或未正确转义的⽤户数据,总之,就是秘密和规矩

五、MySQL数据库

表名不使⽤复数名词,禁⽤保留字,如 desc、range、match、delayed等,请参考MySQL官⽅保留字;

表的命名最好是遵循“业务名称_表的作⽤

代码中写分页查询逻辑时,若 count为0应直接返回,避免执⾏后⾯的分页语句

六、⼯程结构

为避免应⽤⼆⽅库的依赖冲突问题,⼆⽅库发布者应当遵循以下原则:精简可控原则,稳定可追溯原则;

做⼯程时,图⽐较直观,在图中默认上层依赖于下层,箭头关系表⽰可直接依赖。

相关思维导图模板

记账规范思维导图思维导图

树图思维导图提供 记账规范思维导图 在线思维导图免费制作,点击“编辑”按钮,可对 记账规范思维导图  进行在线思维导图编辑,本思维导图属于思维导图模板主题,文件编号是:5f69dab0c9ed8fff28467c3df768699d

标识符规范思维导图思维导图

树图思维导图提供 标识符规范思维导图 在线思维导图免费制作,点击“编辑”按钮,可对 标识符规范思维导图  进行在线思维导图编辑,本思维导图属于思维导图模板主题,文件编号是:0b5f2a7c8b794e300f39c9a6e747f88f