/** @namespace */
var app = {};
/**
* Resuelve la división de a/b
* @example
* // retorna 3
* globalNS.metodo(5, 15);
* @returns {Number} Retorna el resultado de la operación.
*/
app.metodo = function (a, b) {
return b / a;
};
- Documentación oficial
- Speaking JavaScript (Axel Rauschmayer) - Chapter 29. JSDoc: Generating API Documentation
Todo el código en cualquier proyecto debería verse como si una sola persona lo hubiera escrito, sin importar cuánta gente haya contribuído. Idiomatic.js
Desventajas:
- Adopción total del equipo
- Curva de aprendizaje
- Falta de plugins
nota: Si vas muy bien de tiempo, puedes meter estilos y más dinamismo al proyecto: Github | Social Network Project