¿Cuál es la forma estándar de agregar documentación a una función de JavaScript?

Question

Estoy buscando generar documentos API para un proyecto de JavaScript. ¿JavaScript tiene algo similar a la docstring de Python?

function add(a, b) { 
    /** 
    Returns the sum of `a` and `b`. 
    */ 
    return (a - 0) + (b - 0); 
} 

Answer 1

¿Usted ha visto JSDoc (que ahora ha sido sustituida por JSDoc toolkit)?

Answer 2

JSDoc es una forma de hacerlo.

/** 
* Adds two numbers. 
*/ 
function add(a, b) { 
    return a+b; 
} 

Answer 3

Cuando lo necesitaba, JSDoc era la única herramienta disponible, y era bastante desordenado. Siempre recibimos desbordamientos de pila porque usaban perl y expresiones regulares para analizar la fuente. A primera vista, JSDoc Toolkit, como se ve, se ven bien, ahora están usando JavaScript.

Answer 4

PDoc es un generador de documentación en línea para la biblioteca Prototype, escrito en Ruby.