林本磊 / nanyangnet

代码质量建议.md 2.18 KB

1c389624922a191a14c42a07399d377022d0778f/platform/doc/质量审查/代码质量建议.md#">质量问题

1c389624922a191a14c42a07399d377022d0778f/platform/doc/质量审查/代码质量建议.md#">后端

  1. 模板中出现重复导入的js文件。
  2. 模板中css,js文件导入位置未规划，模版创建好后，在浏览器中看实际情况。
  3. 模板中查询数据使用了非固定的自增id，重新部署id会变，代码得改。
  4. 代码未格式化，缩进未统一，空格未一致，未加注释。
  5. 模版中meta中seo字段未使用。
  6. 模版拆分可以更加细致。
  7. 常量名大写，下划线分割。
<html>
  <head>
    <!-- 导入第三方css -->
    <!-- 导入本页面css -->
  </head>
  <body>
    <!-- html标签 -->
    <!-- 导入三方js -->
    <!-- 导入本页面js -->
  </body>
</html>

1c389624922a191a14c42a07399d377022d0778f/platform/doc/质量审查/代码质量建议.md#">前端

  1. 代码未格式化，样式未拆分，整理，无用代码未清理。
  2. 引入的第三方js需要注释其作用，并且使用 min 版本。
  3. script可以抽成一个js文件。
  4. 能用 #id 定位tag的尽量用。
  5. class名称统一格式，全小写使用 - 分割。
  6. 页面、接口url统一格式，全小写使用 - 分割。
  7. 减少行内样式。

1c389624922a191a14c42a07399d377022d0778f/platform/doc/质量审查/代码质量建议.md#">效率问题：

  1. 首先将栏目规划好，所有栏目使用空页面进行占位，并标记todo。
  2. 未完成部分标记为todo，未修复部分标记为fixme。
  3. 只要是你编辑参与过的代码，负责人即为你本人，需将javadoc注释中添加你的名字。多学习javadoc规范写法。
  4. 提交的代码必须经过格式化。尽量做到 0 bug 0 warning。
  5. git提交message格式必须统一，英文冒号，空格。目前格式在慢慢规范化，需要习惯这样要求自己。许多规范的项目或公司，发布版本时生成的更新日志皆是通过提交的message自动生成。
  6. feat和fix提交，皆可关联上tapd需求或缺陷id，方便回顾浏览。
  7. 以需求或缺陷为单位提交代码，不宜攒积过多或过少。

一流企业定标准、二流企业做品牌、三流企业卖技术、四流企业做产品。

1c389624922a191a14c42a07399d377022d0778f/platform/doc/质量审查/代码质量建议.md#">后期目标

1c389624922a191a14c42a07399d377022d0778f/platform/doc/质量审查/代码质量建议.md#">强制审查

强制性自动审查，使用相关工具或插件。前端目前已经采用eslint强制审查，代码不规范无法编译运行。

  1. 代码格式不规范的，无法提交。
  2. 提交消息不规范的，无法提交。