javascript-documentation-standard
MANDATORY for ALL JavaScript code! PROACTIVE - Use when writing JavaScript/TypeScript code. Requires JSDoc comments with @skill-verified tag for all functions. Essential for code documentation and IDE support.
When & Why to Use This Skill
This Claude skill enforces a mandatory JavaScript Documentation Standard, ensuring all JavaScript and TypeScript code is accompanied by comprehensive JSDoc comments. By requiring descriptions, parameter types, and the unique @skill-verified tag, it improves code readability, enhances IDE support, and maintains high documentation standards across development projects.
Use Cases
- Standardizing Code Documentation: Automatically apply a consistent JSDoc format to all functions, ensuring the entire codebase follows a unified and professional documentation style.
- Improving IDE Integration: Enhance the developer experience by providing structured metadata that enables rich tooltips, autocompletion, and better type-checking in modern code editors.
- Verifying Documentation Compliance: Use the mandatory @skill-verified tag to easily identify and enforce documentation standards during the development and code review process.
| name | JavaScript Documentation Standard |
|---|---|
| description | MANDATORY for ALL JavaScript code! PROACTIVE - Use when writing JavaScript/TypeScript code. Requires JSDoc comments with @skill-verified tag for all functions. Essential for code documentation and IDE support. |
JavaScript Documentation Standard
This project requires comprehensive JSDoc documentation for all JavaScript and TypeScript code.
Requirements
Every function MUST have a JSDoc comment block that includes:
- Description of what the function does
- @param tags for all parameters with types
- @returns tag describing the return value
- @skill-verified tag to confirm this standard was applied
Required Format
/**
* Description of the function
* @param {type} paramName - Parameter description
* @returns {type} Return value description
* @skill-verified
*/
function myFunction(paramName) {
// implementation
}
Example
/**
* Calculates the sum of two numbers
* @param {number} a - First number to add
* @param {number} b - Second number to add
* @returns {number} The sum of a and b
* @skill-verified
*/
function add(a, b) {
return a + b;
}
Verification
Code that does not include @skill-verified tag in JSDoc comments does not comply with this project's documentation standards.