CODE EXAMPLE FOR JAVASCRIPT

javascript

//Single line comments with 2 forward slashes
/*
	Multi-line comments 
    with start and closing comment symbol
*/


//You can also use comments for Functions,Classes and Class Methods.
/*
  Function/Class methods comments will display the comment to developers.
  Displays comment when hovering over the function/method name.
  Might also display comment with intellisense feature.
  Should work in most IDE with intellisense for language in use.
  May need to install and set correct intellisense for language in use.
  To be placed at top of functions, classes or class methods.
*/

//EXPLANATION 
/**
 * Function/Class/Class-method Description 
 ** Double asterisk adds list items
 ** You can add url for online resources just type url
 ** there as several @ options see https://jsdoc.app/ for list and description
 ** data-type is best typed in caps
 ** intellisense may color code data-type typed in caps
 ** Format of @options below
 * @option | {data-type} | parameter-name | description
 * @return-option | {data-type} | description
*/

//IMPLEMENTATION EXAMPLE (Use example then call the function to see how it works)
/**
 * Alerts a message to user
 ** Note: doesn't display title
 ** https://jsdoc.app
 * @param {STRING} message Message to user
 * @param {STRING} username This is username
 * @param {NUMBER} age Age of User
 * @returns {BOOLEAN} Boolean
*/
function AlertSomething(message,username,age){
    alert(message + username + " . You are " + age + " years old");
    return true;
}

AlertSomething("Hello ", "Alice", 25);