如何在jsdoc中记录函数和函数构造函数的属性？

Question

For example how would I document this?

var f = function () { var g = function() {}; gh = function(); return g; }

This isn't a pattern I've invented. See http://bost.ocks.org/mike/chart/

Answer 1

Check this link out . Very helpful reference.

Do something like this.

/** 

*@method 
*@param

* {string} parameterA used to process..... 
* @description 
* function is used to process...... 
*/ 

Params is for parameters mentioning its type. Description describes what the function does.

function a(parameterA){}