code-comment-generator

Code Comment Generator

Generate meaningful, maintainable comments and documentation for your code.

Core Capabilities

This skill helps you create effective code documentation by:

1. Analyzing code context - Understanding what the code does and why
2. Matching existing style - Following comment conventions in your codebase
3. Writing clear documentation - Creating function/method/class documentation
4. Adding inline explanations - Explaining complex logic and algorithms
5. Inserting code annotations - Adding TODO, FIXME, and optimization notes

Comment Generation Workflow

Step 1: Analyze Existing Comment Style

Before generating comments, examine the codebase to match style:

Look for:

• Documentation format (docstrings, Javadoc, etc.)
• Comment verbosity level (detailed vs. concise)
• Naming conventions and terminology
• Use of examples in documentation
• Type annotation style

Python Example - Analyze Existing Style:

# If existing code uses this pattern:
def get_user(user_id: int) -> User:
    """
    Retrieve user by ID.

    Args:
        user_id: Unique identifier for the user

    Returns:
        User object if found

    Raises:
        UserNotFoundError: If user doesn't exist
    """
    return db.query(User).get(user_id)

Style Identified:

• Google-style docstrings
• Type hints in signature
• Concise summary line
• Args/Returns/Raises sections
• No examples included

Java Example - Analyze Existing Style:

// If existing code uses this pattern:
/**
 * Retrieves a user by their unique identifier.
 *
 * @param userId the unique identifier for the user
 * @return the User object if found
 * @throws UserNotFoundException if no user exists with the given ID
 */
public User getUser(int userId) throws UserNotFoundException {
    return database.findUser(userId);
}

Style Identified:

• Standard Javadoc format
• Brief summary sentence
• @param, @return, @throws tags
• Formal tone
• No code examples