01、如何规范研发团队写的代码

01、如何规范研发团队写的代码

首页角色扮演代号未命名世界更新时间:2024-08-03
背景

如果一个软件项目中存在多种不同的编码风格,这可能会导致团队的协作变得困难。

而且,如果整个团队的编码风格都不一致,长期来看,当团队成员之间发生调动时,会增加项目的维护成本。

因此,统一整个团队的编码风格是非常必要的。

我们的目标:

统一代码格式规范,提升小组协作和CodeReview的效率,降低研发成本。

EditorConfig

分享一个项目代码风格统一神器 ,只需要命名为 .editorconfig ,保存到自己的项目根目录下,即可让项目下所有文件都统一代码风格,非常棒!

有以下几点作用:

1、有助于跨不同编辑器和 IDE 处理同一项目的多个开发人员保持一致的编码风格。

2、项目由用于定义编码样式的文件格式和文本编辑器插件集合组成,这些插件使编辑器能够读取文件格式并遵守定义的样式。

3、文件易于读取,并且可以很好地与版本控制系统配合使用。

EditorConfig 长什么样?示例文件

# EditorConfig is awesome: https://EditorConfig.org # top-most EditorConfig file root = true # Unix 风格的换行符,每个文件都以换行符结尾 [*] end_of_line = lf insert_final_newline = true # 使用大括号扩展符号匹配多个文件 # 设置默认字符集 [*.{js,py}] charset = utf-8 # 4 空格缩进 [*.py] indent_style = space indent_size = 4 # 制表符缩进(未指定大小) [Makefile] indent_style = tab # lib文件夹下所有的js文件 [lib/**.js] indent_style = space indent_size = 2 # 匹配确切的文件 package.json 或 .travis.yml [{package.json,.travis.yml}] indent_style = space indent_size = 2

效果如下:

会自动显示出代码风格不符合规范地方,方便修改。

有哪些IDE原生支持?

以下编辑器IDE捆绑了对 EditorConfig 的原生支持,不需要安装其他插件。

原生支持的IDE编辑器

如何使用?

所要做的就是将其放入项目的根目录中。

1、Visual Studio

每当 Visual Studio 中打开文件时,.editorconfig 文件设置都将用于帮助格式化文档,并且如果您的代码样式和格式不符合,还会发出警告。

添加.editconfig文件

打开.editconfig文件

2、IntelliJ IDEA

确认了下,2019还不支持,2020以上开始支持。

IntelliJ IDEA 2020

3、Visual Studio Code

可以安装 EditorConfig for VS Code 扩展以获得支持。

,
大家还看了
也许喜欢
更多游戏

Copyright © 2024 妖气游戏网 www.17u1u.com All Rights Reserved