|
EDA365欢迎您登录!
您需要 登录 才可以下载或查看,没有帐号?注册
x
规范管理, c9 h! f! o. {) p6 D
研发管理中,开发规范管理是很重要的一环。& @* F0 a1 @* w, o8 r
提到规范,网上自然有很多人分享,但普遍内容太复杂,至少对中小团队来说太复杂。太复杂的规范,落地代价大,甚至有些是为了规范而规范。3 d+ R! d* {4 X! G- ^0 O# V3 {
所以,我认为最佳的方式是,协商并制定适合自己团队的开发规范,并在日后发展过程按需迭代更新。
2 T8 f8 g% v4 u: h6 q+ o3 D8 y9 ^6 L2 c- I* q
8 k( i6 o* D8 k* G5 r7 d制定和实施规范
) `6 B6 b( p: |* j7 y# x/ C集思广益,集体讨论约定是制定规范的最好方式。集体讨论是为了更好的尊重小伙伴,这样大家内心更容易接受,也为今后的落地实施提供了支撑(或者说大家跳进了自己给自己挖的坑,嘿嘿)。
) ~# _- Z# p9 A- E实施方面有两种情况,自我驱动力强的小伙伴,不需要提醒;另外一些小伙伴,则需要利用主管的权威来辅助,事后监督落实,提醒落实执行自己定的规范。
& p; h: M: W: c# \) x3 ^! E5 z5 i: g F* A3 m. t2 S- G
( r/ l! [% e8 y规范内容
* ~' W* C+ M3 j: {0 E" R5 ?. |内容其实可以有很多,不单单是编码规范,附带介绍一下我们团队的规范内容结构(细节就不多说了):
( p+ V6 M$ c; S+ i
, A# I7 L* `$ U- r" N* D, T! ]6 n/ U% y' q Q! E u
类型 前端 后端(Java)
7 W( O _1 m' \" W: [基础编码规范 符合ESLint 符合阿里编码规范/ V. B( Q( `" @
个性化编码规范 约定团队内的html, js, css等命名和写法 约定项目结构, 空格, 换行等细节
6 I. S& U+ ]# @9 D7 J/ E6 c使用的外部基础框架 Vue, Angular spring boot及spring系列框架
: i5 J+ h" U- e% E9 q+ H, l: ?自研公共代码 以js lib形式提供 以maven module的形式提供
" V( k) W( u/ K2 h8 A代码管理 svn, git svn, git
2 p& B& e# E P( P* \# P1 s, s* d! v模板项目 抽取常用js/css库作为基础项目存在svn,新项目checkout作为基础 定义一套符合团队业务特性的、半自动化代码生成工具。适当半自动化,不一定很精美,能解决大部分无意义低效编码即可/ n0 g, K% ~( [9 C: ~4 y/ m
开发依赖管理 npm maven" S. L% ]% I& p ~* ^
国际化 提前准备国际化结构 提前准备,主要是http json数据内的响应码约定" H4 |4 x* Y5 w" }+ L& }
日志 增删改必写关键日志(时间地点人物事件结果),日志内容参考json的key value格式
: A! U$ n \2 O* N- D3 n5 V. A文档管理 使用网易NEI 前后端相同
* h7 @) u# h' O0 e2 P% H4 i, ^接口定义 RESTful API 前后端相同
: d5 J, R9 b3 {& E+ R5 NIDE VS Code eclipse
4 s0 F: A _+ K( E" N. I/ h- `& qssh终端 X Shell
" U2 m- ?! d P2 \3 D) _数据库 表名,字段名和长度,索引规则,适当引入扩展表等
2 k( a' Y( C3 t! o% g8 t+ g测试 junit+mockmvc测试
% g( Z8 `- c* D0 w( R, `
: O5 J# C5 N6 [) w6 c# i0 P
|: `' R0 J5 g' S/ F$ i- S* G5 L' ]" S1 i7 l& x
; r2 D; ?9 J- ?
|
|