|
|
EDA365欢迎您登录！
您需要 登录 才可以下载或查看，没有帐号？注册
x
规范管理
% L: T$ C2 `7 |) h/ |研发管理中，开发规范管理是很重要的一环。
. ^: B% J/ e0 @7 w提到规范，网上自然有很多人分享，但普遍内容太复杂，至少对中小团队来说太复杂。太复杂的规范，落地代价大，甚至有些是为了规范而规范。
* ?7 J0 ~+ b2 U, j. s所以，我认为最佳的方式是，协商并制定适合自己团队的开发规范，并在日后发展过程按需迭代更新。( R: o$ a7 F0 V2 c& {
/ r, T7 d; I$ D& i! i
0 Q9 y1 c+ r) f4 H+ f: h制定和实施规范: W% K y! F( P" c7 F: V
集思广益，集体讨论约定是制定规范的最好方式。集体讨论是为了更好的尊重小伙伴，这样大家内心更容易接受，也为今后的落地实施提供了支撑（或者说大家跳进了自己给自己挖的坑，嘿嘿）。
8 F+ P' p6 l3 E* L1 e实施方面有两种情况，自我驱动力强的小伙伴，不需要提醒；另外一些小伙伴，则需要利用主管的权威来辅助，事后监督落实，提醒落实执行自己定的规范。& r0 Z" w1 t0 H- H
; A K# k" I2 F/ ^ s
. B; Z+ J, ?( z ^规范内容; v, x9 C- B3 _+ y
内容其实可以有很多，不单单是编码规范，附带介绍一下我们团队的规范内容结构(细节就不多说了)：
2 ? y5 |; m/ O7 Y! O
, C$ W2 ~" X5 ^# s$ d7 X2 Q
3 z' E' N3 w' z类型 前端 后端(Java)% S! _; B& X' b6 ~6 C4 m8 ~
基础编码规范 符合ESLint 符合阿里编码规范
7 c3 r( H0 }6 O7 I, M个性化编码规范 约定团队内的html, js, css等命名和写法 约定项目结构, 空格, 换行等细节& ^+ }" [0 G+ E" s6 S2 R
使用的外部基础框架 Vue, Angular spring boot及spring系列框架
2 f/ L$ W+ e& }+ O1 D6 K6 P自研公共代码 以js lib形式提供 以maven module的形式提供
. c- t7 I& x- m9 D' u8 H* A: s7 f代码管理 svn, git svn, git
% }, J0 Z9 b# Y$ \! X模板项目 抽取常用js/css库作为基础项目存在svn，新项目checkout作为基础 定义一套符合团队业务特性的、半自动化代码生成工具。适当半自动化，不一定很精美，能解决大部分无意义低效编码即可
7 p" y( ^" ]/ E6 @0 o3 v开发依赖管理 npm maven" Q. T9 f- _+ w
国际化 提前准备国际化结构 提前准备，主要是http json数据内的响应码约定
2 C1 D4 z4 \4 f- s0 b& c日志 增删改必写关键日志（时间地点人物事件结果），日志内容参考json的key value格式$ D: Z* Y3 i6 {; _9 m
文档管理 使用网易NEI 前后端相同
( J8 D- v# C; F3 E- G' m7 c& ]3 i- X接口定义 RESTful API 前后端相同& o* k# q/ N( i# k7 E$ O
IDE VS Code eclipse) |; H; w2 X, @9 X
ssh终端 X Shell
M8 ?. Y9 N- Q8 f数据库 表名,字段名和长度,索引规则,适当引入扩展表等
" u0 M6 X# O9 D3 p% _0 y1 A测试 junit+mockmvc测试+ r, w2 G$ E T! Q
( ~0 n( F& T5 V* c6 A5 |$ q1 U/ s9 L$ s/ J8 d8 M
/ ~ C) c/ ^% Z7 e9 C
v4 e7 p* F+ f/ | d' L |
|
/1 
发表于 2021-10-8 10:56
收藏
淘帖
支持！
反对！