home > OMD > codeGuide >

让团队按统一编码规范开发代码

author:zhoulujun@live.cn    hits:

为了在版本控制软件中不再因为格式不同而比较代码,最好让团队统一一下编码规范开发代码。https: github com google styleguide eclipse

为了在版本控制软件中不再因为格式不同而比较代码,最好让团队统一一下编码规范开发代码。

google团队代码规范:https://github.com/google/styleguide

airbnb代码规范: https://github.com/airbnb/javascript

standardjs: https://standardjs.com/readme-zhcn.html

腾讯alloyteam前端团队代码按规范: http://alloyteam.github.io/CodeGuide/

然后根据团队规范,配置相关编辑器的代码提示规范(最好团队统一编辑器),前端团队可以配置各种lint工具,如eslint,prettier等。可以参看《治愈代码洁癖prettier药到病除

eclipse 代码格式管理

下载 eclipse 代码样式文件

https://raw.githubusercontent.com/google/styleguide/gh-pages/eclipse-java-google-style.xml

导入方法:Eclipse->window->preferences->Java->Code Style->Formatter->Import 选择eclipse-java-google-style.xml文件,点击apply,ok 就行了。这样就可以选中代码进行格式化(默认快捷键是Ctrl+Shift+F),保持代码风格一致。

jetbrain系列团队代码风格统一

以intellij为例:导入团队风格配置文件,如Google 提供的 Code Style配置文件

可以在提交代码时候,自动格式化代码

如果没有这个功能,那么仍然会有一些不符合定义风格的代码被提交到Git/SVN中,这个功能则是做提交代码的时候自动进行一次格式化(前提是需要使用IDEA自带的Git/SVN功能提交代码)

设置editorConfig

有些编辑器默认支持editorConfig,如webstorm;而有些编辑器则需要安装editorConfig插件,如ATOM、Sublime、VS Code等

当打开一个文件时,EditorConfig插件会在打开文件的目录和其每一级父目录查找.editorconfig文件,直到有一个配置文件root=true

EditorConfig的配置文件是从上往下读取的并且最近的EditorConfig配置文件会被最先读取. 匹配EditorConfig配置文件中的配置项会按照读取顺序被应用, 所以最近的配置文件中的配置项拥有优先权

editorConfig文档

EditorConfig for VS Code
EditorConfig官网
微软说明
editorconfig-vscode github

参看文章:

让团队按统一编码规范开发代码 https://www.jianshu.com/p/9330d12b35b0

利用Intellij Idea(Android Studio)让团队代码风格更统一 https://www.jianshu.com/p/9f57dbbd6b09

vscode使用editorconfig插件以及.editorconfig配置文件说明(统一代码风格工具——editorConfig) 



转载本站文章《让团队按统一编码规范开发代码》,
请注明出处:https://www.zhoulujun.cn/index.php?m=content&c=index&a=show&catid=215&id=4597