Generates meaningful comments and documentation for code to improve maintenance and readability. Use when adding documentation to Python or Java code, including function/method docstrings, class documentation, inline explanations for complex logic, and code annotations (TODO, FIXME). Analyzes existing comment style in the codebase to match conventions. Produces clear, concise comments that explain the "why" not just the "what", following best practices for each language.
Install with Tessl CLI
npx tessl i github:ArabelaTso/Skills-4-SE --skill code-comment-generator93
Does it follow best practices?
Validation for skill structure
Python docstring style matching
Google-style docstring format
100%
100%
Args section present
100%
100%
Returns section present
100%
100%
Raises section present
66%
100%
Type hints in signatures
0%
100%
Explains WHY not WHAT
70%
70%
No obvious inline comments
100%
100%
Magic numbers explained
50%
87%
Assumptions documented
37%
62%
Complex logic commented
37%
62%
Style matches existing code
100%
100%
Example section present
100%
100%
Without context: $0.2191 · 1m 54s · 10 turns · 17 in / 3,637 out tokens
With context: $0.5226 · 4m 9s · 19 turns · 102 in / 6,084 out tokens
Java Javadoc and annotations
Javadoc format
100%
100%
@param tags
100%
100%
@return tag
100%
100%
@throws tag
0%
25%
@see cross-reference
0%
100%
Class-level Javadoc
70%
100%
Code example in class doc
0%
100%
TODO annotation
50%
66%
FIXME or HACK annotation
50%
100%
No obvious inline comments
75%
100%
Messy condition refactored
100%
100%
Explains WHY in comments
100%
100%
Without context: $0.2261 · 2m 45s · 11 turns · 18 in / 4,455 out tokens
With context: $0.8563 · 4m 46s · 24 turns · 6,309 in / 6,808 out tokens
Regex and business rule commenting
Regex breakdown comment
100%
71%
Business rule context
100%
100%
Consistent domain terminology
100%
75%
Module-level docstring
0%
0%
WHY explained for rules
100%
100%
FIXME or TODO annotation
100%
100%
Google-style docstrings
100%
100%
Type hints present
0%
100%
No state-the-obvious comments
75%
87%
Magic number explained
78%
100%
Without context: $0.2886 · 3m 29s · 12 turns · 19 in / 5,212 out tokens
With context: $0.4848 · 2m 54s · 12 turns · 6,504 in / 5,253 out tokens
Table of Contents
If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.