前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >如何统一、美化编码风格?

如何统一、美化编码风格?

作者头像
WEBJ2EE
发布2019-07-19 12:04:57
5260
发布2019-07-19 12:04:57
举报
文章被收录于专栏:WebJ2EEWebJ2EE

【观点】:团队中保持统一美观的编码风格是绝对有必要滴!

今天给大家介绍两款编码风格美化小工具:

EditorConfig; Prettier;

它们配置简单、主流IDE都支持、Ctrl+S就能触发(忘了 Ctrl+Shift+F 吧

)。

图:ant-design-icons 开源项目中就有使用

1. EditorConfig ?

A. 是什么?

EditorConfig 不是什么软件,而是一个名为 .editorconfig配置文件,该文件描述了项目的编码规范。

图:.editorconfig 的常规配置;

B. 放哪?

通常在项目根目录放一个就ok。

图:.editorconfig放项目根目录就行

C. 需要额外装插件吗?

不需要,主流 IDE 基本都原生支持 EditorConfig;

图:这些 IDE 原生支持 EditorConfig;

D.怎么触发?

Ctrl + S 保存文件时自动触发;

2. Prettier?

A. 是什么?

是个流行的代码格式化工具

动图:使用 Prettier 格式化代码;

B. 需要安装什么?

只需要在项目中安装一个 prettier 组件;

npm install --save-dev --save-exact prettier

C. 需要配置什么?

  • 在项目根目录放一个.prettierrc 配置文件,描述项目代码格式;

图:Prettier 典型配置;

  • 配置 WebStorm,实现保存时(Ctrl + S)触发格式化;

图:Prettier 的 WebStorm 配置;

3. EditorConfig or Prettier?

EditorConfig 很好用,但功能有限(只能控制字符集、缩进、空行)。 Prettier 则更进一步,可以针对语言进行美化,功能更强大。建议将 EditorConfig 与 Prettier 配合使用

参考:

EditorConfig官网:https://editorconfig.org/ Prettier官网:https://prettier.io/

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2018-10-17,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 WebJ2EE 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档