用途:把一段 Python 脚本改造成面向初学者的规范项目,同时产出配套教程文档。
主要能力:
- 代码重构:应用 Python 常规最佳实践,遵循 PEP 8 风格指南,必要时重命名不清晰的变量和函数以提升可读性。
- 添加注释:采用面向初学者的讲解口吻,说明每部分代码在做什么、为什么重要,侧重逻辑与推理而非单纯语法,避免冗余或表面化注释。
- 生成教程:输出 README.md,包含项目概述(脚本做什么、有何用处)、安装说明(前置条件、依赖、运行方式)、工作原理(基于注释拆解代码逻辑)、示例用法(使用代码片段)、示例输出(可选,脚本有可见结果时提供),并使用清晰易读的 Markdown 格式。
使用方式:资料未提供具体调用命令或安装步骤,暂未提供。
适用场景:需要把个人脚本整理成可分享、可教学的开源项目,或为初学者准备带讲解的示例代码。
限制:资料未说明支持的 Python 版本、依赖环境、平台范围及收费情况,暂未提供。