javascript function and class header documentation

Javascript function header documentation
[code language=”javascript”]
/**
* The function description goes here.
* @param {number} a – A variable contains a number
* @param {string} b – A variable contains a string
* @param {boolean} c – A variable contains a boolean value
* @param {object} d – An variable contains an object
* @param {function} e – An variable contains a function
* @return {object} An object
*/
function aFunction(a, b, c, d, e) {
var f; // a local variable
return {};
}
[/code]

Javascript class header documentaion
[code language=”javascript”]
/**
* This class creates a new Person.
*
* @class AClass
* @author Joe
* @copyright Apache 2.0
*/
function Person() {
}
var p = new Person();
[/code]

Search within Codexpedia

Custom Search

Search the entire web

Custom Search