|
|
EDA365欢迎您登录！
您需要 登录 才可以下载或查看，没有帐号？注册
x
规范管理8 K: y4 T( P Y! @
研发管理中，开发规范管理是很重要的一环。( N7 n+ f7 H& a5 \
提到规范，网上自然有很多人分享，但普遍内容太复杂，至少对中小团队来说太复杂。太复杂的规范，落地代价大，甚至有些是为了规范而规范。
3 p A7 {$ T* T8 J所以，我认为最佳的方式是，协商并制定适合自己团队的开发规范，并在日后发展过程按需迭代更新。
: @; x q. n8 X3 M' }0 P1 e& T7 p( V( C; [! k T3 u) G# _8 u
6 }+ j8 B* s* P6 @- C制定和实施规范0 z9 }, k q3 o4 K
集思广益，集体讨论约定是制定规范的最好方式。集体讨论是为了更好的尊重小伙伴，这样大家内心更容易接受，也为今后的落地实施提供了支撑（或者说大家跳进了自己给自己挖的坑，嘿嘿）。
5 o5 c# I0 g; q& }2 e实施方面有两种情况，自我驱动力强的小伙伴，不需要提醒；另外一些小伙伴，则需要利用主管的权威来辅助，事后监督落实，提醒落实执行自己定的规范。5 Q0 I @, {, Y' v- E Z* q
+ }/ i& E2 C. D" b& [
5 u ]; E' S6 ^( l! T6 I9 }规范内容. V% F' N6 U0 m6 s" o! C7 F
内容其实可以有很多，不单单是编码规范，附带介绍一下我们团队的规范内容结构(细节就不多说了)：
% s; |- l1 y( t1 ~1 M
, W; i$ a; ^7 e+ i/ i h8 c3 c% T6 Z* G1 p! j
类型 前端 后端(Java)+ `' D W L! p6 z* ?" i
基础编码规范 符合ESLint 符合阿里编码规范9 ]; H+ K8 b5 ^' q- A
个性化编码规范 约定团队内的html, js, css等命名和写法 约定项目结构, 空格, 换行等细节
0 e, A) o; ?4 A% z5 o7 \% D使用的外部基础框架 Vue, Angular spring boot及spring系列框架
! Y9 D; A+ M! K. ~自研公共代码 以js lib形式提供 以maven module的形式提供
( n# B. w# r" T7 o" C: z$ `! \代码管理 svn, git svn, git0 z+ b5 n) p9 a, e5 b& w& r, A t0 X
模板项目 抽取常用js/css库作为基础项目存在svn，新项目checkout作为基础 定义一套符合团队业务特性的、半自动化代码生成工具。适当半自动化，不一定很精美，能解决大部分无意义低效编码即可
: E. M8 @' l7 @开发依赖管理 npm maven
' Y2 k% x! h, B: u国际化 提前准备国际化结构 提前准备，主要是http json数据内的响应码约定( B3 i9 u1 h! w1 t w) T, |; t# {" ~ \; Z7 j
日志 增删改必写关键日志（时间地点人物事件结果），日志内容参考json的key value格式
% P% l) q" x% \$ p2 u. Z0 K, d K文档管理 使用网易NEI 前后端相同, [7 H' m+ s3 G' }( \7 _% o% P- t
接口定义 RESTful API 前后端相同1 j, g* O8 t+ h- E! g7 v: y" {+ O
IDE VS Code eclipse
5 E; B' F+ c8 C- H- V! Wssh终端 X Shell3 E8 I8 A+ H6 J* X
数据库 表名,字段名和长度,索引规则,适当引入扩展表等- L2 [% x) [/ A* w. M6 g: x: k
测试 junit+mockmvc测试( @$ D; b9 U0 A
% ]' N) Q/ G# Q# f8 j6 l2 w: @1 Q" ~) A$ J5 a% @. R
/ G' ?1 s- A) Q' a
) Y; a1 ^& I: x. V# S |
|
/1 
发表于 2021-10-8 10:56
收藏
淘帖
支持！
反对！