本文档旨在帮助开发者提升代码可读性与一致性，遵循 代码规范指南 推荐的工具与标准。

📌 核心原则

  • 统一性：团队内保持相同缩进（如 2/4 空格）与括号风格
    Code_Formatting_Standard
  • 可维护性：避免过度嵌套，每行不超过 80 字符
  • 工具化：使用 Prettier/Black/clang-format 等工具自动化格式化
    Code_Formatting_Tool

🧩 语言特定规范

语言 缩进 命名 示例
Python 4 空格 snake_case def calculate_total():
JavaScript 2 空格 camelCase function calculateTotal() {
Java 4 空格 camelCase public class Example {
Go 4 空格 snake_case func main() {

✅ 格式化检查清单

  • 所有代码块使用 ```language 语法高亮
  • 函数参数间空格统一（如 func add(a, b int)）
  • 操作符周围保留空格（如 x = 5 + 3）
  • 导入语句按字母排序且合并相同路径
    Code_Import_Example

🛠️ 工具推荐

  1. Prettier - 多语言支持的代码格式化器
  2. Black - Python 专用的自动格式化工具
  3. clang-format - C/C++ 项目格式化标准
  4. prettier-eslint - 实现格式化与 linting 的双向校验

参考 代码规范工具对比 获取更多工具细节。

📚 扩展阅读

保持代码整洁，让协作更高效 💡