|
|
EDA365欢迎您登录！
您需要 登录 才可以下载或查看，没有帐号？注册
x
规范管理
" t. B" B* ~( ], A( y研发管理中，开发规范管理是很重要的一环。
% h2 m* B4 m H2 s( a提到规范，网上自然有很多人分享，但普遍内容太复杂，至少对中小团队来说太复杂。太复杂的规范，落地代价大，甚至有些是为了规范而规范。9 U) [" B: @) K! R- k
所以，我认为最佳的方式是，协商并制定适合自己团队的开发规范，并在日后发展过程按需迭代更新。* k' U g. Y- p$ C
E6 @9 h. P$ N: L" @
O$ m! [ k& e2 {制定和实施规范
' D; q V9 B8 z+ I2 @0 P, i. L集思广益，集体讨论约定是制定规范的最好方式。集体讨论是为了更好的尊重小伙伴，这样大家内心更容易接受，也为今后的落地实施提供了支撑（或者说大家跳进了自己给自己挖的坑，嘿嘿）。
; Y& x& }, ]1 W, z5 u实施方面有两种情况，自我驱动力强的小伙伴，不需要提醒；另外一些小伙伴，则需要利用主管的权威来辅助，事后监督落实，提醒落实执行自己定的规范。
- G; \( u* K9 k: T1 L( y: m+ V' f* T9 k) l4 ^
' e- d( y2 J4 q+ i8 W规范内容
4 i5 D/ ^2 q2 x' |# q内容其实可以有很多，不单单是编码规范，附带介绍一下我们团队的规范内容结构(细节就不多说了)：
g3 g# r& H/ {3 d( l
0 K" l' ]4 \# d9 N1 Q; t% m5 s( |: Q6 F1 D3 H! H0 x
类型 前端 后端(Java)9 Q' W" U3 [) U1 ?6 _3 }
基础编码规范 符合ESLint 符合阿里编码规范8 T# z! r: F" m8 V+ g; i. i
个性化编码规范 约定团队内的html, js, css等命名和写法 约定项目结构, 空格, 换行等细节
) @% a* c! U( D( p3 D3 F使用的外部基础框架 Vue, Angular spring boot及spring系列框架
, z) X* R) B6 _自研公共代码 以js lib形式提供 以maven module的形式提供
% F5 }0 U2 ^# H# N; C* a' [代码管理 svn, git svn, git
) B% Z9 T7 u3 h( L' N5 ~模板项目 抽取常用js/css库作为基础项目存在svn，新项目checkout作为基础 定义一套符合团队业务特性的、半自动化代码生成工具。适当半自动化，不一定很精美，能解决大部分无意义低效编码即可
) @& }) W& Z3 \( a开发依赖管理 npm maven
# M M6 V3 X' x$ @国际化 提前准备国际化结构 提前准备，主要是http json数据内的响应码约定% B6 Y6 P6 Q% ?) g* ~4 w9 k% j
日志 增删改必写关键日志（时间地点人物事件结果），日志内容参考json的key value格式: c$ T6 b2 W1 {! D. Q0 G; I
文档管理 使用网易NEI 前后端相同
$ X7 U* I- p- V6 Y接口定义 RESTful API 前后端相同
* R+ S4 K+ M# JIDE VS Code eclipse9 v! k# }( Q7 d4 }, R9 E* [! X, `- e
ssh终端 X Shell) i" ~0 x8 f8 ]! T! F4 i+ X
数据库 表名,字段名和长度,索引规则,适当引入扩展表等
% }+ q0 Q" h( H0 X- x3 x. l# f测试 junit+mockmvc测试. n2 O" b7 m+ U+ f$ o1 ?: O4 K
" H) X2 l8 B* I& v. {: M
- ^' i8 Q) I( x( ^) O# v
" w9 k) G3 [( E8 q
% n) {) |- `, W6 k5 i9 \ |
|
/1 
发表于 2021-10-8 10:56
收藏
淘帖
支持！
反对！