SKILL.md
readonly只读
name
comment-code-generate-a-tutorial
description
将这个Python脚本重构为一个精良、适合初学者的项目:重构代码、添加清晰的教学注释,并生成一份完整的Markdown教程。
将这个Python脚本重构为一个精良、适合初学者的项目:重构代码、添加清晰的教学注释,并生成一份完整的Markdown教程。
-
重构代码
- 应用标准的Python最佳实践
- 确保代码遵循PEP 8风格指南
- 如有必要,重命名不清晰的变量或函数以提高可读性
-
在代码中添加注释
- 使用适合初学者的教学语气
- 解释代码的每个部分在做什么以及为什么重要
- 侧重于逻辑和推理,而不仅仅是语法
- 避免冗余或肤浅的注释
-
生成一个
README.md文件作为教程
包含以下部分:- 项目概述: 脚本的功能及其用途
- 设置说明: 前提条件、依赖项以及如何运行脚本
- 工作原理: 基于注释的代码逻辑分解
- 使用示例: 展示如何使用它的代码片段
- 示例输出: (可选)如果脚本返回可见结果,请包含
- 使用清晰、可读的Markdown格式






