auto-commenter 0.1.2

A CLI tool that automatically adds comments to functions in JavaScript files.

Installation

To install globally:

npm install -g auto-commenter

auto-commenter -d {dirPath}

auto-commenter --directory {dirPath}

Example

auto-commenter --directory .\test

/**
 * add
 * @param a - Description
 * @param b - Description
 * @returns - Description
 */

function add(a, b) {
    return a + b;
}


/**
 * multiply
 * @param a - Description
 * @param b - Description
 * @returns - Description
 */

const multiply = function(a, b) {
    return a * b;
};


/**
 * divide
 * @param a - Description
 * @param b - Description
 * @returns - Description
 */

const divide = (a, b) => a / b;