comment-code-generate-a-tutorial 是一个把 Python 脚本整理成入门项目的 Skill。你有能说明某件事的脚本,希望其他人看懂、运行并继续学习,可以让它同时整理代码和教程。
它按 Python 规范调整代码,必要时改掉不清楚的变量与函数名,再添加解释性注释。注释要说为什么这样做、逻辑怎样推进,不是每行都重复一次语法。
随后生成 README:项目用途、依赖和运行方法、代码逻辑、使用例子。脚本确实返回可见结果时,才考虑加入样例输出。你需要提供原脚本和所需环境信息;原文没有安排完整测试流程,改完仍应核对行为与示例,避免教程讲得更清楚,代码却悄悄变了。