为了代码质量,你都坚持了哪些习惯?

想看下大家平时都保持什么习惯来控制代码质量,一起学习一下。

programmer
212 views
Comments
登录后评论
Sign In
·

能不写的就不写

·

·

坚持使用谷歌+英文搜索

·

(评论区好真实)

好的代码习惯包括:

  1. 运算符左右留空格
  2. 驼峰命名法
  3. 打草稿寻找最优算法并保存草稿和注释
  4. 写注释
·

非必要不做mutable的声明

少用for循环

类型安全

·

看到乱写的就像骂

·

选择类型安全的写法,比如前端 redux,用 toolkit + typescript 避免大量模板和字符串,后端 sql 使用 queryDSL 或 jooq 等带类型推断的 sql,避免大量 xml 文件或 sql 字符串(如果有复杂 read 需求,可以上 mybatis,write 还是 jpa 模型)。

很多细分领域仅一种语言 A 难以覆盖需求,就需要在 A 语言上再搞一种 dsl,比如 vue 的模板、mybatis 的 xml 语法、jpa 的 nativeSQL 参数注入语法,这些模板都很难实现类型安全,在改字段、加字段的时候容易静默故障,项目复杂的时候很难定位。

·

各种代码 lint,比如 eslint,format,团队强制遵守编码风格,不符合风格的代码无法 commit/push

·

敲了几年代码已经习惯敲完一句立刻格式化一下代码了。prettier 在前端生态是非常流行和好用的代码格式化工具。配合上 eslint-plugin-prettier 在代码提交前进行检查,不符合格式的不允许提交,很好的保证了同事之间的协作顺畅,并且方便自己回过头来阅读代码。另外可以打开编辑器的保存自动格式化功能,这样更方便点,但建议仅针对项目进行配置。