Code Documentation

aj-geddes/useful-ai-prompts/skills/code-documentation

by aj-geddes3f5182cfd739No license355 starsListed Oct 8, 2026Updated Oct 8, 2026Repository updated 7 months ago

Write comprehensive code documentation including JSDoc, Python docstrings, inline comments, function documentation, and API comments. Use when documenting code, writing docstrings, or creating inline documentation.

Instructions onlySoftware Development

AI-generated overview

Writes code documentation such as JSDoc, Python docstrings, JavaDoc and inline comments.

What it does: This skill guides an agent in producing code documentation: function and class documentation, type definitions, module documentation, API comments and inline comments. It supplies language-specific conventions such as JSDoc, Python docstrings and JavaDoc, plus a quick-start example and best-practice do and don't lists. Reference guides and a documentation template are included as supporting material.
When to use it: Use it when documenting code, writing docstrings or adding inline documentation. It fits tasks covering public APIs, parameters, return values, thrown errors, usage examples and type definitions.
Requirements: No scripts; it is instructions plus reference guides and a template. The agent only needs to read the bundled markdown files.

Overview

Create clear, comprehensive code documentation using language-specific standards like JSDoc, Python docstrings, JavaDoc, and inline comments.

When to Use

Function and class documentation
JSDoc for JavaScript/TypeScript
Python docstrings
JavaDoc for Java
Inline code comments
API documentation from code
Type definitions
Usage examples in code

Quick Start

Minimal working example:

javascript

/** * Calculates the total price including tax and discount. * * @param {number} basePrice - The base price before tax and discount * @param {number} taxRate - Tax rate as a decimal (e.g., 0.08 for 8%) * @param {number} [discount=0] - Optional discount amount * @returns {number} The final price after tax and discount * @throws {Error} If basePrice or taxRate is negative * * @example * const price = calculateTotalPrice(100, 0.08, 10); * console.log(price); // 98 * * @example * // Without discount * const price = calculateTotalPrice(100, 0.08); * console.log(price); // 108 */function calculateTotalPrice(basePrice, taxRate, discount = 0) {  if (basePrice < 0 || taxRate < 0) {    throw new Error("Price and tax rate must be non-negative");  }  return basePrice * (1 + taxRate) - discount;}
// ... (see reference guides for full implementation)

/** * Calculates the total price including tax and discount. * * @param {number} basePrice - The base price before tax and discount * @param {number} taxRate - Tax rate as a decimal (e.g., 0.08 for 8%) * @param {number} [discount=0] - Optional discount amount * @returns {number} The final price after tax and discount * @throws {Error} If basePrice or taxRate is negative * * @example * const price = calculateTotalPrice(100, 0.08, 10); * console.log(price); // 98 * * @example * // Without discount * const price = calculateTotalPrice(100, 0.08); * console.log(price); // 108 */function calculateTotalPrice(basePrice, taxRate, discount = 0) {  if (basePrice < 0 || taxRate < 0) {    throw new Error("Price and tax rate must be non-negative");  }  return basePrice * (1 + taxRate) - discount;}
// ... (see reference guides for full implementation)

Reference Guides

Detailed implementations in the references/ directory:

Guide	Contents
Function Documentation [blocked]	Function Documentation
Class Documentation [blocked]	Class Documentation
Type Definitions [blocked]	Type Definitions
Function Documentation [blocked]	Function Documentation
Class Documentation [blocked]	Class Documentation
Module Documentation [blocked]	Module Documentation

Best Practices

✅ DO

Document public APIs thoroughly
Include usage examples
Document parameters and return values
Specify thrown exceptions/errors
Use language-specific standards (JSDoc, docstrings, etc.)
Keep comments up-to-date
Document "why" not "what"
Include edge cases and gotchas
Add links to related functions
Document type definitions
Use consistent formatting

❌ DON'T

State the obvious in comments
Leave commented-out code
Write misleading comments
Skip examples for complex functions
Use vague parameter descriptions
Forget to update docs when code changes
Over-comment simple code

Source and attribution

Source:aj-geddes/useful-ai-promptsinskills/code-documentationat commit3f5182c

License: No license

Content belongs to its original authors. SourceWeft indexes it from a public repository.

Report or request removal

Code Documentation

Code Documentation

Table of Contents

Overview

When to Use

Quick Start

Reference Guides

Best Practices

✅ DO

❌ DON'T

Source and attribution

More from aj-geddes/useful-ai-prompts

Xss Prevention

Wireframe Prototyping

Web Performance Optimization

Vue Application Structure

Visual Regression Testing

User Persona Creation

More in Software Development

Playground

M5 Onboard

Cardputer Buddy

Web Design Guidelines

Vercel React Native Skills

Vercel React Best Practices