设计模式之美笔记 —— 代码规范

设计模式之美 - 31

设计模式之美 - 32

设计模式之美 - 33

项目内使用的规范需要保持风格统一,整齐划一

目录

一、命名:原则就是以能准确达意为目标

二、注释:就是为了让代码更容易看懂

三、类和方法多大合适

四、一行代码多长最合适

五、善用空行分割单元块

六、类中成员的排序顺序

七、把代码分割成更小的单元块

八、避免函数参数过多

九、勿用函数参数来控制逻辑

十、函数设计要职责单一

十一、移除过深的嵌套层次

十二、学会使用解释性变量


一、命名:原则就是以能准确达意为目标

1、命名多长合适:

对于局部变量,偏向于使用短命名方式;

对于类名等影响范围比较大的,偏向于使用长命名来更为准确的表达意思;

2、利用上下文来讲话命名:

借助类名来简化变量的命名

3、命名要可读、可搜索:

比如查询都用select***,就不要新增query**来标识查询。便于搜索select即可获取项目中所有的查询方法。

4、如何命名接口和抽象类:

项目中需要统一,比如接口都是各种** Service,而实现都是**ServiceImpl


二、注释:就是为了让代码更容易看懂

注释的内容主要包含这样三个方面:做什么、为什么、怎么做。注释需要简介明了

  • 类和方法:一定要写注释,尽量写的全面和详细
  • 方法内部:注释相对需要少一点,需要靠命名来达意。

三、类和方法多大合适

以可读性 和 复杂性 来作为大小是否合适的评判标准,太大可读性查,太小会增加调用关系的复杂性。


四、一行代码多长最合适

原则:保持代码整洁,方便代码阅读

可以遵循的一个原则是:一行代码最长不能超过 IDE 显示的宽度


五、善用空行分割单元块


六、类中成员的排序顺序

类中:成员变量排在函数的前面

成员变量和函数间:首先按照先静态,后普通。除此之外,还需要按照作用域来排序 先public,然后protected,最后private。还有另外一种排列习惯,那就是把有调用关系的函数放到一块


七、把代码分割成更小的单元块

将复杂的逻辑提炼查分成类或者方法


八、避免方法参数过多

通过将一个方法拆分成多个 或者 将参数封装成对象的方式,来解决参数过多的情况。


九、勿用函数参数来控制逻辑

 


十、函数设计要职责单一

 


十一、移除过深的嵌套层次

 


十二、学会使用解释性变量

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值