commenting standards javascript code example
Example 1: javascript function description standards
/**
* @name hash
* @description Random hashing algorithm I found on Stack Overflow.
* @param {string} str
* @param {boolean} asString
* @param {*} seed
*
* @returns {string} hash
*/
function hash(str, asString, seed) {
Example 2: javascript Name convention
// camelCase
//The general rule is to start variable, function and method names
//with a lowercase letter, class and object names with a capitalized letter,
//and constants are typically all caps.
//Follow these conventions, and your scripts will
//be consistent with what others are doing, and much easier to understand.