Missing Necessary Knowledge for CS Students
  • 前言
  • 基础知识
    • Git
      • 安装
      • 基本命令
      • Git Commit Template
      • GitHub
    • Vim
      • 安装
      • 教程
    • 学会获取信息
      • 学会使用英文搜索信息
      • 阅读官方文档
    • 调试
      • 断点调试
      • 网页调试
    • 测试
    • 代码规范
      • 不同编程语言的代码规范
      • 注释与文档
    • 工具链
      • 代码格式化工具（Formatter）
      • 代码检查工具（Linter）
      • 包管理器与依赖管理工具
      • 打包工具
    • 抽象
      • 封装
      • 重构
      • 究竟什么是抽象
    • 编程语言
      • 编译器与解释器
      • 强类型与弱类型
      • 静态类型与动态类型
      • 面向对象与函数式编程
    • 其他
      • Markdown
      • Jupyter Notebook
      • 虚拟机与 Docker
      • CI/CD
  • 附：一些常见工具的使用
    • Scoop
Powered by GitBook
On this page
  1. 基础知识
  2. 工具链

代码格式化工具（Formatter）

Previous工具链Next代码检查工具（Linter）

Last updated 2 years ago

在中，我们提到了“代码规范（Code Standards）”的概念。然而，在实际的编程工作中，我们总是很难完全记住所有的代码规范。因此，出现了一些工具帮助我们在编写代码时自动遵守、或提示我们遵守代码规范。

这类工具通常包括“代码格式化工具（Formatter）”与“代码检查工具（Linter）”。本小节主要介绍代码格式化工具。

代码格式化工具（Formatter）是负责将代码按照某一标准进行格式化的工具。例如，下面是使用 Python 的代码格式化工具 autopep8 格式化一段糟糕的 Python 代码的示例。

下面列出一些编程语言常见的代码格式化工具。

  • Python - Autopep8 / Black

  • Java - Google Java Format

  • C++ - Clang-Format

  • JavaScript/TypeScript - Prettier

  • Ruby - RuboCop

  • Go - gofmt

  • Rust - RustFmt

上一节
Before
After