Welcome everyone

新手编码试炼(一)

编码 汪明鑫 112浏览 0评论

1,大方法往往要抽小方法

    抽方法的目的:

    a,可读性(主要)

    b,可重用

 

2,命名的作用大于注释

     类、方法、变量命名命的好,可以在很大程度上提升可读性

     不要过分注释,复杂逻辑、关键地方需要注释

 

3,日志:

     a,可读性

     b,携带足够上下文,也不要太复杂

     c,日志不要泛滥,容易造成线上无用日志过多

     d,异常、错误打出堆栈信息

     e,不要打出敏感信息

     f,最好不要用中文

 

4,代码设计以简单为主,不能过分设计

     可读性要放在第一位

 

5,code review

     a,新人代码风格与团队对齐

     b,提cr的人要尊重reviewers的时间,要提前过一遍

     c,不要一次提交太多太多代码,不要给reviewers带来太多负担,可分多次提交

     d,强迫写出别人看的懂的代码

     e,业务、组件类库学习,代码能力提升的一种方式

 

【推荐书籍】

编写可读代码的艺术

重构 改善既有代码的设计

代码整洁之道

 

转载请注明:汪明鑫的个人博客 » 新手编码试炼(一)

喜欢 (0)

说点什么

您将是第一位评论人!

提醒
avatar
wpDiscuz