可追踪性是一种被低估的代码指标

主要观点:在维护不熟悉的代码库时,通过 grep 代码库查找字符串很重要,由此得出保持代码库可 grep 的规则。
关键信息:

  • 不要拆分标识符,如动态构造表名、列名等不利于维护和查找。
  • 在整个栈中使用相同的名称,避免在应用边界重命名字段导致查找困难。
  • 扁平结构比嵌套结构更好,如翻译文件和 React 组件结构的示例。
    重要细节:
  • 示例中动态构造表名的函数可改为直接返回固定表名,避免搜索遗漏。
  • 导入 postgres 风格标识符后转换为 camelCase 会增加查找难度。
  • 翻译文件的第二种结构更易查找,React 组件结构也是扁平的更便于 grep 查找。
阅读 14
0 条评论