在协作开发中维持统一的文件格式和代码风格

了解伙伴用什么操作系统

Windows 和类 Unix 系统在文本处理方面有很多差异,考虑到 WSL 情况可能会复杂点,起项之初便要制定好统一规则:

  • 使用什么作为换行符(当然 LF
  • 文件权限位注意不要动(目前一个项目中,有个文件的可执行权限总是被 Windows 搭档抹掉,恼火!)

特别关注文件权限问题

已知在某些环境下(比如 WSL)对文件权限支持有问题,要在这种环境下关闭 filemode 的识别!

git config core.filemode false

参见 [1] [2]

了解伙伴用什么编辑器

了解搭档所用编辑器的默认设定和奇怪癖好,对于不好调教的编辑器,要劝其放弃!

利用 EditorConfig

EditorConfig 帮助不同开发人员使用不同编辑器时维持统一的风格,建议起项之初便要引入并妥善配置!

root = true

[*]
end_of_line = lf
indent_style = space
indent_size = 4
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true

利用 .gitattributes

* text=auto eol=lf
*.{cmd,[cC][mM][dD]} text eol=crlf
*.{bat,[bB][aA][tT]} text eol=crlf

制定风格规范

制定风格规范,并取得所有开发人员的认同。

Code Review

特别是在初期,开发负责人要细心检视搭档最近的提交!

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • 更新版,之前的版本可以看这里:梳理前端开发使用eslint和prettier来检查和格式化代码问题 一、问题痛点 ...
    dnaEMx阅读 4,349评论 0 7
  • 一.editorconfig 是EditorConfig的配置文件。 EditorConfig是为了帮助开发人员维...
    一爷之秋阅读 678评论 0 0
  • 拦截器Authentication 权限Caching 缓存Context passing 内容传递Error h...
    范er_er阅读 64评论 0 0
  • 泉水 叮叮咚咚的落下 落在婴儿的额头上 绽放出花瓣 花瓣飘着 落在雪山上 一瓣又一瓣 生了根 婴儿睡着了 微笑着 ...
    赵稚生阅读 150评论 0 0
  • 学校所在的社区,这几天循环播放着《打铜锣》《补锅》《刘海砍樵》等花鼓戏。那熟悉的音乐,熟悉的唱段,不禁让人...
    湖溪钓翁阅读 820评论 0 1