What kind of comments does it add?

It adds module-level summaries, class/function responsibilities (arguments, returns, exceptions), and inline comments for complex logic blocks or edge cases.

Does this skill change my code's behavior?

No, the skill is strictly constrained to adding comments and docstrings. It performs a self-check to ensure no imports, logic, or variable names are altered.

How does it handle existing docstrings?

It respects existing documentation and only appends missing information to avoid redundancy while maintaining the original style where possible.

Does it work with languages other than Python?

This specific skill is optimized for Python (.py) files to ensure accurate parsing of docstrings and PEP 8 standards.

Python Code Commentator

Name: Python Code Commentator
Author: tyhts0829

bytyhts0829

0•

学习与文档

Enhances Python code readability by adding comprehensive docstrings and explanatory comments without altering program logic.

The comment-detailed skill is a specialized tool for developers who need to quickly understand or document complex Python scripts. It systematically analyzes a file's responsibilities, I/O, and side effects to generate high-quality module-level docstrings, function descriptions, and inline comments. Unlike standard formatters, it focuses on the 'why' behind the code—explaining intent, constraints, and edge cases—ensuring that the script remains 100% behaviorally identical while becoming significantly easier to maintain and audit.

主要功能

01Adds context-aware inline comments explaining logic intent and constraints

02Identifies entry points, side effects, and global state interactions

03Generates comprehensive module and function-level docstrings

04Ensures zero changes to original code behavior or execution logic

05Performs syntax verification via py_compile after adding documentation

060 GitHub stars

使用场景

01Onboarding new developers by making complex internal scripts self-explanatory

02Documenting legacy Python codebases to simplify long-term maintenance

03Preparing internal scripts for code review or public open-source release

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add tyhts0829/grafix comment-detailed

For use in Claude.ai and ChatGPT

Download Skill