CODE-STYLE.js

"use strict";

/**
 * Short description of file/module.
 *
 * This module lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis semper velit ante, et aliquet leo aliquet non.
 * nec sem magna. Phasellus hendrerit neque dui, at lobortis ipsum fermentum non. Aenean egestas velit felis, vel
 * interdum neque volutpat at. Nulla facilisi. Pellentesque porttitor, erat id congue sollicitudin, arcu nulla porttitor
 * eros, vel porta velit purus a magna. Class aptent taciti sociosqu ad litora torquent per conubia stra,  per inceptos
 * himenaeos. Nam pretium ipsum ex, ac aliquet lectus ultrices a.
 *
 * The following is an example of writing things `in code`, which is displayed with monospace font.
 *
 * Notes:
 *     Cras sit amet velit justo. Nam feugiat neque erat, quis sodales tortor tincidunt ac. Curabitur ultricies vitae elit
 *     imperdiet suscipit. Etiam non venenatis nisl, nec hendrerit tellus. Nullam eget lacus pulvinar risus commodo
 *     volutpat. Aenean in tempus sem. Vestibulum dolor quam, egestas vel sodales vel, tincidunt sed ante. Morbi lobortis
 *     neque sapien, dapibus efficitur odio consectetur eget. Praesent a ex ligula. Aliquam erat volutpat. Curabitur eros
 *     ipsum, tincidunt malesuada porta vitae, placerat congue velit.
 */

// =====================================================================================================================
// Section summary for block of code.
// ----------------------------------
// Add optional notes here.  Pellentesque congue interdum mauris sed pretium. Pellentesque mollis accumsan arcu,
// ut pellentesque nisl convallis sed.
//
// Maecenas orci dolor, tempor id tristique sed, vestibulum ut risus. Maecenas eu mi molestie, hendrerit velit
// quis, consequat lorem. Phasellus eget risus vel sapien suscipit fermentum nec quis augue.
// =====================================================================================================================

// Subsection description.
// -----------------------

/** Short description of variable */
var dummyVar = 0;

/**
 * Short description of function.
 *
 * Longer description of function. Class aptent taciti sociosqu ad litora torquent per conubia stra, per inceptos
 * himenaeos. Nam pretium ipsum ex, ac aliquet lectus ultrices a.
 *
 * Args:
 *     arg1 (int): Description of argument 1.
 * 
 * Return:
 *     (bool): Description of return 1.
 */
 function func1(arg1) {
    // This is how to write longer style comments within method bodies.
    // Stars are used for interface comments and slash symbols are used for
    // for implementation comments.
    return true;
 }