mcpField
C
comment-code-generate-a-tutorial

comment-code-generate-a-tutorial

github.com/github开发40.5k8.9k 次安装1 天前更新
代码仓库

关于 comment-code-generate-a-tutorial

将 Python 脚本整理为适合初学者学习的项目：重构代码、添加教学注释，并生成结构清晰的 README.md 教程，适用于教学和文档编写。

主要功能

  1. 01按 Python 惯例重构代码
  2. 02遵循 PEP 8 风格
  3. 03添加面向初学者的解释性注释
  4. 04生成结构化 README.md 教程

适用场景

  1. 01将脚本改为初学者教学材料
  2. 02记录环境配置和运行步骤
  3. 03为学习项目讲解代码逻辑

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/github/awesome-copilot --skill comment-code-generate-a-tutorial

安装后在 Claude Code 中输入/comment-code-generate-a-tutorial确认已加载。

详细介绍

通过重构代码、添加清晰的教学式注释并生成完整的 Markdown 教程，将这个 Python 脚本打造成一个精致、适合初学者的项目。

  1. 重构代码

    • 应用标准的 Python 最佳实践
    • 确保代码遵循 PEP 8 风格指南
    • 如有需要，重命名不清晰的变量和函数以提高可读性

  2. 在代码中添加注释

    • 使用适合初学者的教学式语气
    • 解释代码的每一部分在做什么，以及为什么重要
    • 重点关注逻辑和推理，而不仅仅是语法
    • 避免冗余或流于表面的注释

  3. 生成一个教程作为 README.md 文件
    包含以下部分：

    • Project Overview: 该脚本的作用及其用途
    • Setup Instructions: 先决条件、依赖项以及如何运行脚本
    • How It Works: 基于注释对代码逻辑进行拆解说明
    • Example Usage: 展示如何使用它的代码片段
    • Sample Output: （可选）如果脚本会返回可见结果，则包含此项
    • 使用清晰、易读的 Markdown 格式

评论

支持 Markdown