Project Nova 代码规范

本页面旨在为 Project Nova 社区提供一套统一的代码规范，以确保项目代码的一致性和可维护性。

语言风格

• 英文：访问 /en/Community/Forum/Project_Nova/Documentation/Code_Convention 获取英文版本
• 中文：当前页面为中文版本

规范内容

1. 编码风格

• 使用 UTF-8 编码
• 代码缩进使用 4 个空格，不要使用制表符
• 代码行长度不超过 80 个字符

2. 文件命名

• 使用小写字母和下划线命名，如 function_name.py
• 避免使用下划线开头，如 _function_name.py
• 遵循 PEP 8 命名规范

3. 函数和类

• 函数和类名使用驼峰命名法，如 functionName 和 ClassName
• 函数参数使用小写字母和下划线命名，如 function_name parameter
• 遵循 PEP 8 函数和类命名规范

4. 注释

• 使用清晰、简洁的注释，描述代码功能和实现细节
• 文档注释使用 """ 包围，如：

def function_name(parameter):
    """
    函数功能描述

    参数:
        parameter: 参数描述
    """
    # 函数实现

5. 异常处理

• 使用 try-except 块捕获和处理异常
• 遵循 PEP 8 异常处理规范

6. 代码审查

• 所有代码提交前必须经过代码审查
• 代码审查关注点包括但不限于：代码风格、逻辑错误、性能问题

扩展阅读

• Project Nova 官方文档

Project_Nova Logo