Skip to content

SJTU-RoboMaster-Team/style-team

Repository files navigation

这是仓库链接,含 Format 配置文件

这份规范提供类似 Rust 的排版。如果你觉得这还挺好看,你可以使用 Clang-Format 自动使用这些规范,不需要手动调整。方法:

  • 将本仓库的 .clang-format.clang-tidy 文件拷贝至你的工作区根目录下。
  • 在编辑器中开启 Clang-FormatClang-Tidy 插件。插件通常默认使用工作区根目录下的配置文件。
  • 执行编辑器的格式化文档命令,例如在 VSCode 中可以打开命令面板搜索 Format。也可以开启保存时自动格式化。

设计原则

  • 可读性 🐰

    • 阅读速度
    • 防止误导
    • 可访问性 - 适用于不同硬件环境下,包括非可视化环境
    • 在编译器报错信息中的可读性
  • 美学 🏛

    • sense of beauty
    • 与现代编程语言保持一致
  • 细节 🖋

    • 易于进行版本维护
    • 尽可能兼容未来代码
    • 增加代码密集度,防止右飘
  • 应用 👶🏻

    • 规则易于手动实践(在最简编辑环境中)
    • 规则易于自动实践(当可以使用 Clang-Format 等其他工具时)
    • 规则的一致性
    • 保持风格规则的简并性