本项目旨在提供一个清晰、一致和易于遵循的格式化指南,以确保所有贡献者都能保持代码质量和可读性。

语言风格

根据您的请求,以下内容为中文。

基本规则

  • 所有代码文件应使用一致的缩进和空格规则。
  • 使用UTF-8编码格式保存所有文件。
  • 请遵循PEP 8 -- Python 编程风格指南,除非有特殊说明。

代码格式化工具

我们推荐使用以下工具来自动格式化代码:

  • Black:一个可配置的代码风格指南,用于 Python。
  • Prettier:一个一致化的代码格式化工具,支持多种语言。

示例

这是一个函数的示例:

def add_numbers(a, b):
    return a + b

术语表

以下是一些在格式化过程中可能会用到的术语:

  • 缩进:在代码中使用空格或制表符来表示代码块的层次结构。
  • 空格:用于改善代码的可读性。
  • 换行:用于分隔代码块。

链接

更多关于代码格式化的信息,请参考代码风格指南

图片示例

下面是 Python 编程的图标:

Python_programming_icon