跳到主要内容

前端编码规范

提交代码要求

1、提交代码必须review,确认无问题再提交
2、提交代码,必须进行SVN对比,看是否有多余的修改
3、任何与功能无关的修改不允许提交,比如: 格式化、行位去空格、修改顺序、缩进(要求只提交最精简的改动)
4、提交代码,修改日志必须同步提交
5、修改代码导致功能使用变化,必须同步写文档

代码注释和日志规范

【第一部分】代码注释规范

[1].SVN提交注释
---author:scott---date:20130203---for:[bug号]树机构调整---
[2].代码修改日志注释
---author:scott---date:2021/11/22-----for:[bug号]树机构调整---
[3].代码修改痕迹注释
//update-begin---author:scott ---date:20140212 for:[bug号]树机构调整------------
//update-end---author:scott ---date:20140212 for:[bug号]树机构调整--------------
[4].代码缺陷或遗留未完成功能标记
//TODO author:zhangdaihao for:插入未完成 date:20130711

【第二部分】日志文件

   代码修改日志    :/doc/代码修改日志
数据库修改日志:/doc/DB修改日志.sql

代码格式化要求

1、新代码必须格式化
2、老代码不允许格式化(除非大重构)

前端代码格式化配置

先设置prettier

通过右键格式化代码