|
EDA365欢迎您登录!
您需要 登录 才可以下载或查看,没有帐号?注册
x
规范管理2 p6 g" J5 x& x. {5 v
研发管理中,开发规范管理是很重要的一环。8 n- R) ^; g/ \* q) T: I+ E3 M/ m
提到规范,网上自然有很多人分享,但普遍内容太复杂,至少对中小团队来说太复杂。太复杂的规范,落地代价大,甚至有些是为了规范而规范。
; e( ] ^& p0 k" z7 k# D0 i. D所以,我认为最佳的方式是,协商并制定适合自己团队的开发规范,并在日后发展过程按需迭代更新。( \% U+ y: c4 d6 O0 }) |/ x1 J" B
3 c7 F; [) R1 U) L
( @( }7 g0 B; H7 ^制定和实施规范
9 i# i4 N9 K. p6 S. L5 b集思广益,集体讨论约定是制定规范的最好方式。集体讨论是为了更好的尊重小伙伴,这样大家内心更容易接受,也为今后的落地实施提供了支撑(或者说大家跳进了自己给自己挖的坑,嘿嘿)。
4 \, [+ |0 V: x1 j实施方面有两种情况,自我驱动力强的小伙伴,不需要提醒;另外一些小伙伴,则需要利用主管的权威来辅助,事后监督落实,提醒落实执行自己定的规范。/ U4 ?8 j2 C3 q9 c; n/ b) A
' V" W0 U! s/ y7 U
* p6 m7 {! [8 E# X/ F规范内容
4 o2 L; c W- e内容其实可以有很多,不单单是编码规范,附带介绍一下我们团队的规范内容结构(细节就不多说了):
; v3 P/ [; X8 w! s8 ?
* G# k$ i# q# B5 ~# P: w% c
# ~& k3 A+ R8 {8 d类型 前端 后端(Java): L- }) {6 c0 R n: i# J0 q3 z' F
基础编码规范 符合ESLint 符合阿里编码规范/ y- h) ]/ u3 u( o. M/ `
个性化编码规范 约定团队内的html, js, css等命名和写法 约定项目结构, 空格, 换行等细节
! }# c _" W, v) ?& L使用的外部基础框架 Vue, Angular spring boot及spring系列框架, v- f& v; I- z2 l
自研公共代码 以js lib形式提供 以maven module的形式提供; @* `5 E1 c8 M
代码管理 svn, git svn, git
) q0 j# J# j' Z+ y7 H6 \模板项目 抽取常用js/css库作为基础项目存在svn,新项目checkout作为基础 定义一套符合团队业务特性的、半自动化代码生成工具。适当半自动化,不一定很精美,能解决大部分无意义低效编码即可 L& G, x9 \5 O# ] C- p
开发依赖管理 npm maven
' Y6 E( g- {9 _国际化 提前准备国际化结构 提前准备,主要是http json数据内的响应码约定5 A8 A. c( c* L) k, h8 M. F) ^
日志 增删改必写关键日志(时间地点人物事件结果),日志内容参考json的key value格式9 h- ]' x5 s% u7 T. Z
文档管理 使用网易NEI 前后端相同2 b1 N6 p: I5 B8 L2 D9 n6 z, W
接口定义 RESTful API 前后端相同. X8 k* d6 ^7 f* I5 b' ?
IDE VS Code eclipse
1 s; K: C6 p1 ]& {" i/ cssh终端 X Shell
3 E& S% O& A' M) S3 n, {% g数据库 表名,字段名和长度,索引规则,适当引入扩展表等3 G/ U0 a* o1 x) e3 @' U; Q6 p) V
测试 junit+mockmvc测试
( J7 P& O Y; E5 a* Y2 `" F- M( x
, c$ ~1 V( [8 o2 ?1 n, {* p8 G( v/ `$ P
0 ^, ^" i5 @% A0 x
$ b/ d$ j1 {0 O4 r/ B5 ^# C9 F
|
|