javascript-documentation-standard
所有JavaScript代码的强制要求!主动 - 在编写JavaScript/TypeScript代码时使用。所有函数需要带有@skill-verified标签的JSDoc注释。对代码文档和IDE支持至关重要。
📖 中文导读:所有JavaScript代码的强制要求!主动 - 在编写JavaScript/TypeScript代码时使用。所有函数需要带有@skill-verified标签的JSDoc注释。对代码文档和IDE支持至关重要。 以下正文为该技能的原始 SKILL.md 内容(英文),上方安装命令可直接使用。
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.