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. 01Python の慣例に沿ったリファクタリング
  2. 02PEP 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を入力して読み込まれたか確認します。

詳細

この Python スクリプトを、コードをリファクタリングし、わかりやすい解説コメントを追加し、完全な Markdown チュートリアルを生成することで、洗練された初心者にやさしいプロジェクトに変換します。

  1. コードをリファクタリングする

    • 標準的な Python のベストプラクティスを適用する
    • コードが PEP 8 スタイルガイドに従っていることを確認する
    • 明確さのために、必要に応じて不明瞭な変数名や関数名を変更する

  2. コード全体にコメントを追加する

    • 初心者にやさしい、解説調のトーンを使用する
    • コードの各部分が何を行っているか、なぜそれが重要なのかを説明する
    • 構文だけでなく、ロジックとその理由に焦点を当てる
    • 冗長または表面的なコメントは避ける

  3. README.md ファイルとしてチュートリアルを生成する
    以下のセクションを含めます：

    • プロジェクト概要： スクリプトが何を行うか、なぜ役立つか
    • セットアップ手順： 前提条件、依存関係、スクリプトの実行方法
    • 仕組み： コメントに基づくコードロジックの内訳
    • 使用例： 使い方を示すコードスニペット
    • 出力例： （任意）スクリプトが目に見える結果を返す場合に含める
    • 明確で読みやすい Markdown フォーマットを使用する

コメント

Markdown 対応