首页
/ Python代码规范参考

Python代码规范参考

2026-04-09 09:31:33作者:仰钰奇

命名约定

  • 函数名: 使用snake_case
  • 类名: 使用CamelCase
  • 常量: 使用全大写SNAKE_CASE

代码风格

  • 每行代码不超过79个字符
  • 使用4个空格缩进
  • 函数和类之间空两行

#### 完善SKILL.md
```markdown
---
name: 代码质量审查助手
description: 分析Python代码质量问题,提供规范检查和改进建议
---

# 代码质量审查助手

## 功能说明
自动检测Python代码中的常见问题,包括未使用变量、硬编码敏感信息等,并提供符合PEP8规范的改进建议。

## 使用方法
1. 接收用户提供的Python代码或文件路径
2. 执行代码分析: `python scripts/code_analyzer.py <file>`
3. 参考`references/code_standards.md`生成规范建议
4. 输出结构化审查报告

💡 元数据优化namedescription字段决定Claude何时使用该技能,应包含关键触发词如"代码审查"、"Python"等。

思考点:如果要支持多种编程语言,这个技能架构需要如何调整?资源组织方式会有什么变化?

测试与验证:确保技能质量

1. 运行验证脚本

scripts/package_skill.py code-review-assistant

2. 手动测试流程

  1. 准备测试代码文件test_code.py
  2. 调用技能分析代码
  3. 验证输出是否符合预期
  4. 检查是否遗漏重要代码问题

3. 完善错误处理

增强脚本健壮性:

# 添加到code_analyzer.py
def analyze_code(code):
    issues = []
    try:
        # 原有分析逻辑...
    except Exception as e:
        issues.append(f"分析过程出错: {str(e)}")
    return issues

💡 测试技巧:创建包含各种常见问题的测试代码库,确保技能能识别不同类型的代码问题。

思考点:如何设计自动化测试来验证技能的有效性?需要考虑哪些测试场景?

打包发布:分享你的技能

1. 最终打包

scripts/package_skill.py code-review-assistant ./dist

打包成功后生成dist/code-review-assistant.zip文件。

2. 发布准备

  • 编写技能使用示例
  • 准备技能截图(如有)
  • 撰写提交说明

3. 贡献到社区

通过项目的Pull Request流程提交你的技能,确保:

  • 技能功能完整
  • 文档清晰
  • 代码无明显错误

常见问题解决

1. 技能元数据验证失败 ★☆☆

问题:打包时提示"YAML metadata missing required fields" 解决方案

  • 检查SKILL.md开头的YAML块
  • 确保包含namedescription字段
  • 使用在线YAML验证工具检查格式

2. 脚本执行权限问题 ★☆☆

问题:运行脚本时提示"Permission denied" 解决方案

chmod +x code-review-assistant/scripts/code_analyzer.py
登录后查看全文
热门项目推荐
相关项目推荐