|
|
EDA365欢迎您登录！
您需要 登录 才可以下载或查看，没有帐号？注册
x
规范管理5 O; @9 o. H* F/ X
研发管理中，开发规范管理是很重要的一环。
$ s' D. L! c' j* D6 S0 ^" H提到规范，网上自然有很多人分享，但普遍内容太复杂，至少对中小团队来说太复杂。太复杂的规范，落地代价大，甚至有些是为了规范而规范。
! c5 u" G6 z+ x/ j j所以，我认为最佳的方式是，协商并制定适合自己团队的开发规范，并在日后发展过程按需迭代更新。; y* g" H4 Z$ s* z( Q
/ e, K0 Y3 B# \3 q% Z9 o, m/ p% p; V; K
制定和实施规范
2 {+ a: w0 {7 j7 c- b集思广益，集体讨论约定是制定规范的最好方式。集体讨论是为了更好的尊重小伙伴，这样大家内心更容易接受，也为今后的落地实施提供了支撑（或者说大家跳进了自己给自己挖的坑，嘿嘿）。$ M6 o4 J* j6 g& T6 d
实施方面有两种情况，自我驱动力强的小伙伴，不需要提醒；另外一些小伙伴，则需要利用主管的权威来辅助，事后监督落实，提醒落实执行自己定的规范。! a; c& P2 H" n% ~6 t3 J
; X: r$ n+ e0 B) D; {
+ v2 S' t2 C2 N9 P! C# k规范内容 ~$ t2 ^% z; g7 ^3 o8 f0 b
内容其实可以有很多，不单单是编码规范，附带介绍一下我们团队的规范内容结构(细节就不多说了)：
+ @: u3 _( ?9 i, F- Y8 h9 ]- Q$ V' Q4 ~$ U7 p( m
% C9 `+ a2 m% n6 Q) m类型 前端 后端(Java): Y# r) o$ ^: Q
基础编码规范 符合ESLint 符合阿里编码规范/ s8 r* w [: M4 k3 Y4 x y: L, V
个性化编码规范 约定团队内的html, js, css等命名和写法 约定项目结构, 空格, 换行等细节
! ]/ X! H9 u' A4 u' h4 {使用的外部基础框架 Vue, Angular spring boot及spring系列框架2 [# v7 Z# [' A1 i* _6 q
自研公共代码 以js lib形式提供 以maven module的形式提供
E6 I* K1 q. ^& x. C0 l代码管理 svn, git svn, git
! J/ ~# K x' y" r k模板项目 抽取常用js/css库作为基础项目存在svn，新项目checkout作为基础 定义一套符合团队业务特性的、半自动化代码生成工具。适当半自动化，不一定很精美，能解决大部分无意义低效编码即可
8 ?! o+ V: m# e9 P" Y3 `7 N0 i! y: w开发依赖管理 npm maven
# Y' S& @* J4 i0 f1 h) `国际化 提前准备国际化结构 提前准备，主要是http json数据内的响应码约定8 R4 g* W& x. ]) @& {2 k
日志 增删改必写关键日志（时间地点人物事件结果），日志内容参考json的key value格式
8 b! _/ e& i$ w/ `' g: R5 X' W @; i文档管理 使用网易NEI 前后端相同# H% [6 G6 {/ H/ E
接口定义 RESTful API 前后端相同1 L% E+ G* d0 ]( ?3 `* K
IDE VS Code eclipse, U/ e5 }% ~+ g
ssh终端 X Shell: x2 k* c$ s& [6 G9 k
数据库 表名,字段名和长度,索引规则,适当引入扩展表等
- U8 z9 x u( X! Z/ o测试 junit+mockmvc测试
& ~8 j' l1 A' B. k3 h) A4 W' o" S6 r3 b5 u4 }
" a. ?* g6 V6 i- @4 D
6 ?' f4 s, U, q4 S" i% y9 p$ a/ F& J' J$ z7 a- J5 i9 p% K
|
|
/1 
发表于 2021-10-8 10:56
收藏
淘帖
支持！
反对！