code-comment-generator

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.

1.23x

Quality

92%

Does it follow best practices?

Impact

89%

1.23x

Average score across 3 eval scenarios

Securityby

Passed

No known issues

Evaluation results

90%

17%

Add Documentation to a Python Inventory Management Module

Python docstring style matching

Criteria

Without context

With context

Google-style docstring format

100%

Args section present

100%

Returns section present

100%

Raises section present

66%

100%

Type hints in signatures

100%

Explains WHY not WHAT

70%

No obvious inline comments

100%

Magic numbers explained

50%

87%

Assumptions documented

37%

62%

Complex logic commented

37%

62%

Style matches existing code

100%

Example section present

100%

92%

27%

Document a Java Subscription Billing Service

Java Javadoc and annotations

Criteria

Without context

With context

Javadoc format

100%

@param tags

100%

@return tag

100%

@throws tag

25%

@see cross-reference

100%

Class-level Javadoc

70%

100%

Code example in class doc

100%

TODO annotation

50%

66%

FIXME or HACK annotation

50%

100%

No obvious inline comments

75%

100%

Messy condition refactored

100%

Explains WHY in comments

100%

85%

Document a Python Data Validation Module for Financial Onboarding

Regex and business rule commenting

Criteria

Without context

With context

Regex breakdown comment

100%

71%

Business rule context

100%

Consistent domain terminology

100%

75%

Module-level docstring

WHY explained for rules

100%

FIXME or TODO annotation

100%

Google-style docstrings

100%

Type hints present

100%

No state-the-obvious comments

75%

87%

Magic number explained

78%

100%

Repository: ArabelaTso/Skills-4-SE
Commit: 0f00a4f

Evaluated: 29 days ago
Agent: Claude Code
Model: Claude Sonnet 4.6

Table of Contents

Add Documentation to a Python Inventory Management Module Document a Java Subscription Billing Service Document a Python Data Validation Module for Financial Onboarding

Is this your skill?

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.