Table of Contents
Effective code documentation is essential for maintaining and scaling software projects. Automating this process can save time and ensure consistency. Here are four ready-to-use prompts that can help automate code documentation effectively.
1. Generate Function Documentation
Use this prompt to create detailed documentation for individual functions or methods in your codebase. It helps clarify the purpose, parameters, return values, and potential side effects.
Prompt example: “Generate a comprehensive documentation comment for the following function, including description, parameters, return value, and examples.”
Sample input:
“`python def calculate_area(radius): return 3.14 * radius * radius “`
Expected output:
“””
Calculates the area of a circle given its radius.
Parameters:
– radius (float): The radius of the circle.
Returns:
float: The area of the circle.
Example:
calculate_area(5) → 78.5
“””
2. Create Class Documentation
This prompt helps generate documentation for classes, including descriptions of attributes and methods. It ensures clarity for object-oriented code.
Prompt example: “Write a class-level docstring for the following class, describing its purpose and main attributes.”
Sample input:
“`python class Car: def __init__(self, make, model, year): self.make = make self.model = model self.year = year “`
Expected output:
“””
Represents a car with specific make, model, and manufacturing year.
Attributes:
– make (str): The manufacturer of the car.
– model (str): The model name or number.
– year (int): The manufacturing year.
Methods:
– __init__: Initializes a new car instance with make, model, and year.
3. Automate API Endpoint Documentation
This prompt is designed to generate documentation for API endpoints, including request methods, parameters, and response formats.
Prompt example: “Create documentation for the following API endpoint, including method, URL, parameters, and response.”
Sample input:
“`json { “method”: “GET”, “url”: “/api/users/{id}”, “parameters”: { “id”: “User ID” }, “response”: { “id”: “User ID”, “name”: “Full Name”, “email”: “Email Address” } } “`
Expected output:
“””
Endpoint: GET /api/users/{id}
Description: Retrieves information about a user by their unique ID.
Parameters:
- id (path parameter): The unique identifier of the user.
Response:
- id: User’s unique ID.
- name: Full name of the user.
- email: User’s email address.
4. Summarize Code Blocks
This prompt helps generate concise summaries of code snippets, explaining their purpose and functionality in simple terms. Ideal for documentation and teaching.
Prompt example: “Provide a brief summary of what the following code does.”
Sample input:
“`javascript function isPrime(num) { if (num <= 1) return false; for (let i = 2; i <= Math.sqrt(num); i++) { if (num % i === 0) return false; } return true; } ```
Expected output:
This function checks if a number is prime by testing divisibility from 2 up to its square root.