Trae AI 插件编码规范：如何生成符合标准的代码

生成符合标准的代码需遵循以下核心原则，确保代码可读性、可维护性和高效性：

1. 代码结构与风格

• 命名规范：变量/函数名使用小写蛇形命名（如 calculate_score），类名使用大驼峰命名（如 DataProcessor）。
• 模块化设计：功能拆分为独立函数/类，单一职责原则（每个函数不超过 20 行）。
• 格式统一：缩进（4 空格）、空行（函数间空 2 行）、行宽（不超过 80 字符）。

2. 错误处理与健壮性

• 异常捕获：明确处理可能异常（如文件读取、网络请求）。
• 输入验证：对所有外部输入进行类型/范围检查。
• 资源管理：使用上下文管理器确保资源释放（如 with open()）。

3. 文档与注释

• 函数文档：用 docstring 描述功能、参数和返回值（遵循 Google 风格）：

  def normalize_data(data: list) -> float:
      """计算数据集的归一化值
      
      Args:
          data: 输入数据列表
      
      Returns:
          归一化后的标量值
      """
  

• 关键注释：在复杂逻辑处添加行内注释（避免描述显而易见的内容）。

4. 性能优化

• 避免冗余计算：缓存重复使用的中间结果。
• 高效数据结构：根据场景选择集合（set）或字典（dict）替代列表遍历。
• 算法复杂度：优先选择 $O(n \log n)$ 或更低复杂度的算法。

5. 测试与验证

• 单元测试覆盖：为每个函数编写测试用例（使用 pytest 等框架）。
• 边界测试：验证极端输入（如空列表、超大数值）。
• 持续集成：通过自动化测试确保代码更新不破坏原有功能。

示例代码（符合规范）

import numpy as np

class DataAnalyzer:
    """数据分析器，支持均值和标准差计算"""
    
    def __init__(self, data: list[float]):
        self.data = data
        self._validate_input()
    
    def _validate_input(self) -> None:
        """验证输入数据有效性"""
        if not isinstance(self.data, list):
            raise TypeError("输入必须为列表")
        if len(self.data) == 0:
            raise ValueError("数据不能为空")

    def calculate_mean(self) -> float:
        """计算数据均值
        
        Returns:
            均值结果（保留两位小数）
        """
        return round(np.mean(self.data), 2)
    
    def calculate_std(self) -> float:
        """计算标准差
        
        Returns:
            标准差结果（保留两位小数）
        """
        return round(np.std(self.data), 2)

# 单元测试示例（pytest）
def test_data_analyzer():
    analyzer = DataAnalyzer([1.0, 2.0, 3.0])
    assert analyzer.calculate_mean() == 2.0
    assert analyzer.calculate_std() == 0.82

关键实践总结：

• 可扩展性：通过类封装便于新增功能（如添加分位数计算）。
• 防御式编程：_validate_input 防止无效输入导致崩溃。
• 数值精度：结果保留小数点避免浮点误差累积。
• 测试驱动：单元测试直接验证核心逻辑正确性。

提示：实际开发中需结合具体框架（如 TensorFlow/PyTorch）的 API 规范，并定期使用 flake8 等工具进行代码静态检查。