本页面介绍了我们项目的编码规范,旨在确保代码的一致性和可维护性。

语言风格

  • 中文:本页面默认使用中文。
  • 英文:访问 /en/coding_standards 可查看英文内容。

规范内容

以下是我们的编码规范的主要内容:

代码格式

  • 使用一致的缩进和空白字符。
  • 代码行长度建议不超过80个字符。
  • 函数和类名应使用驼峰命名法。

注释

  • 每个函数和类都应有详细的注释。
  • 注释应简洁明了,避免冗余。

代码审查

  • 定期进行代码审查。
  • 审查重点包括代码质量、规范性和可维护性。

版本控制

  • 使用Git进行版本控制。
  • 提交时,请确保代码的可读性和可维护性。

其他

  • 遵守国家相关法律法规。
  • 避免使用敏感词汇。

扩展阅读

编程规范