home > OMD > codeGuide >

讓團隊按統一編碼規范開發代碼

author:[email protected]    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) 



轉載本站文章《讓團隊按統一編碼規范開發代碼》,
請注明出處:http://www.qsexmk.tw/index.php?m=content&c=index&a=show&catid=215&id=4597