|
|
EDA365欢迎您登录！
您需要 登录 才可以下载或查看，没有帐号？注册
x
规范管理
# `5 Z* V7 H6 E" k研发管理中，开发规范管理是很重要的一环。6 N% t: |1 M& J/ M* q
提到规范，网上自然有很多人分享，但普遍内容太复杂，至少对中小团队来说太复杂。太复杂的规范，落地代价大，甚至有些是为了规范而规范。$ p- q, }2 }; S* E* \
所以，我认为最佳的方式是，协商并制定适合自己团队的开发规范，并在日后发展过程按需迭代更新。3 f! }+ O! M7 N5 L, S5 N' \
/ t8 G8 e/ ?0 O& ?9 g; ]7 O2 I- E6 e, N5 M; T- N4 b: b
制定和实施规范4 d! W* E- X5 q# k
集思广益，集体讨论约定是制定规范的最好方式。集体讨论是为了更好的尊重小伙伴，这样大家内心更容易接受，也为今后的落地实施提供了支撑（或者说大家跳进了自己给自己挖的坑，嘿嘿）。
. f& V# Q9 e) W- H) H3 k9 l4 [& C3 ~1 W: j实施方面有两种情况，自我驱动力强的小伙伴，不需要提醒；另外一些小伙伴，则需要利用主管的权威来辅助，事后监督落实，提醒落实执行自己定的规范。- y" R3 X$ H1 Z% n2 ~ K8 e
0 T o8 p# x( ^! q B% q
! s7 w3 B* ] L* K/ \ E3 }1 v% ~规范内容
7 ?2 W, z- i$ b' V7 h内容其实可以有很多，不单单是编码规范，附带介绍一下我们团队的规范内容结构(细节就不多说了)：! ]: n! K7 d5 b
4 ^, t; h( `- z2 m$ b
7 z% R: E7 T1 i0 j& c
类型 前端 后端(Java)5 H5 s- t; X" U2 I; b4 [% A; ?+ |
基础编码规范 符合ESLint 符合阿里编码规范) ?5 u9 Z( w# z5 j( A2 B
个性化编码规范 约定团队内的html, js, css等命名和写法 约定项目结构, 空格, 换行等细节
+ I5 s) v+ }5 z使用的外部基础框架 Vue, Angular spring boot及spring系列框架* R, U( Z2 D; ?! E
自研公共代码 以js lib形式提供 以maven module的形式提供# c; Z: h! f) O0 e( t' m$ R/ i
代码管理 svn, git svn, git! u: }' [; [" J( L% _
模板项目 抽取常用js/css库作为基础项目存在svn，新项目checkout作为基础 定义一套符合团队业务特性的、半自动化代码生成工具。适当半自动化，不一定很精美，能解决大部分无意义低效编码即可9 \+ D- [5 Y& Q u2 O
开发依赖管理 npm maven, y9 R3 _, r( G: L2 G% C
国际化 提前准备国际化结构 提前准备，主要是http json数据内的响应码约定
+ p/ {' J7 b8 E0 W' P日志 增删改必写关键日志（时间地点人物事件结果），日志内容参考json的key value格式2 O7 @' a( M, Q K5 j5 O! G
文档管理 使用网易NEI 前后端相同/ U' z9 s7 r. O) z. K: ]; h6 [
接口定义 RESTful API 前后端相同
3 V; `+ |: A; e2 G$ n. g; o8 V F- YIDE VS Code eclipse
2 q9 v( n$ p5 d0 x- M' X, C& mssh终端 X Shell
8 Z& k0 g* J- ~% C6 M数据库 表名,字段名和长度,索引规则,适当引入扩展表等
3 L- r- s/ X' g$ O" b* i* P测试 junit+mockmvc测试
8 {' G1 C* l8 B, X& [' w$ {; a6 B+ ^1 I! o. d0 u: D. o9 I) g2 s" B
. y! ~0 x7 [# f3 H k
6 r; C [! I1 u: s9 X2 `
( a- i2 z* Y+ x$ n- Z. ? |
|
/1 
发表于 2021-10-8 10:56
收藏
淘帖
支持！
反对！