编码规范

2020-07-09

设计原则与设计模式使用好了,能有效地改善代码质量,但非常依赖个人经验。而编码规范简单明了,在提高代码的可读性方面,立竿见影。

1、命名

  • 长度:足够表达含义的情况下,越短越好;默认的、熟悉的单词可以使用缩写
  • 利用上下文简化命名:借助类的信息来简化属性、函数的命名,利用函数的信息来简化函数参数的命名
  • 可读、可搜索

 

2、注释

  • "好的命名完全可以替代注释",观点有点极端,命名不可能做到足够详细
  • 注释的目的就是让代码更容易看懂
  • 写明"做什么"、"怎么做",起到总结性与文档的作用
  • 让代码结构更清晰
  • 在复杂的类或者接口的注释中写明"怎么用"
  • 注释太多会对代码阅读产生干扰,也增加了后期的维护成本
  • 注释太少过一段时间可能自己都忘记了代码的意图与作用

 

3、格式

ConstXiong 备案号:苏ICP备16009629号-3