JSDoc - 產生API說明文件

JSDoc
https://jsdoc.app/

用法

1. 註解(comment) /** */
2. 標記(tags) @
3. HTML
4. 型別註釋(type notation)

   /** Repeat <b>AAA</b>
    * @namespace 
    */

/**
 * Represents a book.
 * @constructor
 * @param {string} title - The title of the book.
 * @param {string} author - The author of the book.
 * @param {string | number} [code = 0] - The code of the book.
 * @param {string[]} tags - The tags of the book.
 */
 
function Book(title, author, code, tags) {
}

5. 名稱路徑(NamePath)

/** @constructor */
var Person = function() {
    this.say = function() {
        return "I'm an instance.";
    }

    function say() {
        return "I'm inner.";
    }
}
Person.say = function() {
    return "I'm static.";
}

var p = new Person();
p.say();      // I'm an instance.
Person.say(); // I'm static.
// there is no way to directly access the inner function from here

Person#say  // the instance method named "say."
Person.say  // the static method named "say."
Person~say  // the inner method named "say."

@class
@leads NamePath

/** 
 * A class for managing persons.
 * @class 
 */
var Person = makeClass(){
    /** @leads Person# */
    {
     say: function(message) {
        return "This person says" + message;
     }
    }
};

@constructs
@memberof

var Person = makeClass(){
    /** 
    * A class for managing persons.
    * @constructs Person
    */
 
    /** @memberof Person# */
    {
     say: function(message) {
        return "This person says" + message;
     }
    }
};

@extends namePath
標示子類別

/** 
 * @constructor 
 * @extends Person
 */

function Programmer(name){
    Person.call(this, name);
};

https://github.com/jsdoc/jsdoc