handlebars4code/docs/tpl/javascriptcomments_tpl.js

library and NPM module that extends Handlebars with Helpers for Code Generation in a specific programming language (e.g. Javascript)

vDataJSON.tpl.javascriptcomments = `
//#################################################################
{{#ifcond data.reposinfo.static "!=" "yes"}}
//# Javascript Class: {{data.classname}}()
{{#ifcond data.superclassname "!=" " "}}
{{#ifcond data.superclassname "!=" ""}}
//#       SuperClass: {{data.superclassname}}
{{/ifcond}}
{{/ifcond}}
//#   Class Filename: {{filename data.classname}}.js
{{/ifcond}}
{{#ifcond data.reposinfo.static "==" "yes"}}
//# Javascript Module: {{data.classname}}
{{#ifcond data.superclassname "!=" " "}}
{{#ifcond data.superclassname "!=" ""}}
//#           Extends: {{data.superclassname}}
{{/ifcond}}
{{/ifcond}}
//#       Filename: {{filename data.classname}}.js
{{/ifcond}}
//#
//# Author of Class:      {{data.reposinfo.author}}
//# email:                {{data.reposinfo.email}}
//# Created:              {{data.reposinfo.created}}
//# Modified              {{data.reposinfo.modified}}
//# GNU Public License V3 - OpenSource
//#
//# created with JavaScript ClassEditorUML
//#     https://niebert.github.io/ClassEditorUML
//#################################################################

{{#ifcond data.reposinfo.require_classes "!=" "yes"}}
//---------------------------------------------------------------------
//---Store File in Subdirectory /js and import this Class in HTML-File with
// SCRIPT-Tag:  LANGUAGE="JavaScript" SRC="js/{{filename classname}}.js"
{{/ifcond}}
{{#ifcond data.reposinfo.require_classes "==" "yes"}}
//---------------------------------------------------------------------
{{#ifcond data.superclassname "!=" ""}}
{{#ifcond data.superclassname "!=" " "}}
//---------------------------------------------------------------------
// NodeJS: require the super class
const {{data.superclassname}} = require('{{filename data.superclassname}}');
{{/ifcond}}
{{/ifcond}}
//---- USED CLASSES: ----
// Used classes in parameters of methods, return values of methods and attributes
{{#requireclass data settings}}
// - {{variable}}
{{/requireclass}}

// NodeJS: Require additional Modules
{{#requirelibs data.reposinfo.requirelist}}
const {{variable}} = require('{{module}}'); // Module: {{module}}
{{/requirelibs}}

{{/ifcond}}
//---------------------------------------------------------------------
// Configuration Code:
{{{data.reposinfo.configcode}}}
{{#ifcond data.reposinfo.static "==" "yes"}}
//---------------------------------------------------------------------
//---Object: {{data.classname}}
// The static object {{data.classname}} has attributes and functions.
//--- Attributes: -------------------------------
{{#foreach data.attributes data}}
    // ------------------------------------------
    // {{visibility}}: {{name}}   Type: {{class}}
    // {{data.classname}}.{{name}} = {{{init}}};   // Class: {{class}}
{{/foreach}}
//--- Functions: -------------------------------
{{#foreach data.methods data}}
    // -----------------------------------------
    // {{visibility}}: {{name}}
    // {{data.classname}}.{{name}}({{#paramcall parameter}}{{/paramcall}});
{{/foreach}}
//----------------------------------------------
{{/ifcond}}
{{#ifcond data.reposinfo.static "!=" "yes"}}
//---------------------------------------------------------------------
//---Constructor of Class {{data.classname}}()
// Call the constructor for creating an instance of class {{data.classname}}
// by the following command in HTML-file that imports this class
// var v{{data.classname}} = new {{data.classname}}();
//---------------------------------------------------------------------
//----Attributes-------------------------------------------------------
//---------------------------------------------------------------------
// If you want to access the attributes of {{data.classname}} in the code for methods, use
// the attribute name with a leading "this." in the definition of method of {{data.classname}}, e.g.
// this.aName = "Hello World";
//---------------------------------------------------------------------
//----Methods----------------------------------------------------------
//---------------------------------------------------------------------
// (1) If you want to assign definitions of methods for single instance of the class '{{data.classname}}'
// they are defined with
//    this.my_method = function (pPar1,pPar2)
// this approach allows to overwrite the method definition of single instances dynamically.
//---------------------------------------------------------------------
// (2) A prototype definition of methods for '{{data.classname}}' will be set by
// use the method's name and extend it with '{{data.classname}}'.
//    {{data.classname}}.prototype.my_method = function (pPar1,pPar2)
// This approach consumes less memory for instances.
//---------------------------------------------------------------------

{{#ifcond data.superclassname "!=" " "}}
{{#ifcond data.superclassname "!=" ""}}
//--------------------------------------
//---Super Class------------------------
// Inheritance: '{{data.classname}}' inherits from '{{data.superclassname}}'
{{data.classname}}.prototype = new {{data.superclassname}}();
// Constructor for instances of {{data.classname}} has to updated.
// Otherwise constructor of '{{data.superclassname}}' is called
{{data.classname}}.prototype.constructor={{data.classname}};
// see http://phrogz.net/js/classes/OOPinJS2.html for explanation
//--------------------------------------
{{/ifcond}}
{{/ifcond}}


function {{data.classname}} () {
    //---------------------------------------------------------------------
    //---Attributes of Class "{{data.classname}}()"
    //---------------------------------------------------------------------

{{#foreach data.attributes data}}
    // ------------------------------------------
    // {{visibility}}: {{name}}   Class: {{class}}
{{#ifcond comment "!=" ""}}
{{indent comment "    // "}}
{{/ifcond}}
{{#ifcond visibility "==" "public"}}
    this.{{name}} = {{{init}}};   // Class: {{class}}
{{/ifcond}}
{{#ifcond visibility "==" "private"}}
    var {{name}} = {{{init}}};   // Class: {{class}}
{{/ifcond}}
{{/foreach}}
    //---------------------------------------------------------------------
    //---Methods of Class "{{data.classname}}()"
    //---------------------------------------------------------------------
{{#foreach data.methods data}}

    // #################################################################
    // # {{visibility}} Method: {{name}}()  Class: {{data.classname}}
    // # Parameter:
    // #    {{parameterlist parameter "    // #    "}}
    // # Comment:
{{indent comment "    // #    "}}
    // # {{{returncomment}}}
    // #################################################################
{{/foreach}}

}
//---------------------------------------------------------------------
//---END Constructor for Call  "new {{data.classname}}()"
//---------------------------------------------------------------------
{{#foreach data.methods data}}

    //#################################################################
    //# {{visibility}} Method: {{name}}()  Class: {{data.classname}}
    //# Parameter:
    //#    {{parameterlist parameter "    //#    "}}
    //# Comment:
{{indent comment "    //#    "}}
    //# {{{returncomment}}}
    //#################################################################

{{#ifcond visibility "==" "public"}}
    {{data.classname}}.prototype.{{name}} = function ({{#paramcall parameter}}{{/paramcall}}) {
{{#ifcond data.reposinfo.debugheader "==" "yes"}}
            //----Debugging------------------------------------------
            // console.log("{{filename data.classname}}.js - Call: {{name}}({{#paramcall parameter}}{{/paramcall}})");
            // alert("{{filename data.classname}}.js - Call: {{name}}({{#paramcall parameter}}{{/paramcall}})");
            //----Create Object/Instance of {{data.classname}} and call {{name}}()----
            //    var v{{data.classname}} = new {{data.classname}}();
            //    v{{data.classname}}.{{name}}({{#paramcall parameter}}{{/paramcall}});
            //-------------------------------------------------------
{{/ifcond}}


{{/ifcond}}
{{#ifcond visibility "==" "private"}}
    function {{name}}({{#paramcall parameter}}{{/paramcall}}) {
{{#ifcond data.reposinfo.debugheader "==" "yes"}}
            //----Debugging------------------------------------------
            // console.log("{{filename data.classname}}.js - Call: {{name}}({{#paramcall parameter}}{{/paramcall}})");
            // alert("{{filename data.classname}}.js - Call: {{name}}({{#paramcall parameter}}{{/paramcall}})");
            //-------------------------------------------------------
{{/ifcond}}
{{/ifcond}}
{{indent code "      "}}
    }
    // ---- Method: {{name}}() Class: {{data.classname}} ------
{{/foreach}}
{{/ifcond}}
{{#ifcond data.reposinfo.static "==" "yes"}}
{{#ifcond data.superclassname "==" " "}}
//--------------------------------------------
//---Define Static Class - Export Variable ---
// A static class '{{data.classname}}' does not need a constructor 'new {{data.classname}}()'
//--------------------------------------------
var {{data.classname}} = {};
{{/ifcond}}
{{#ifcond data.superclassname "!=" ""}}
{{#ifcond data.superclassname "!=" " "}}
//-------------------------------------------
//---Extend Static Class---------------------
// A static class '{{data.classname}}' does not need a constructor 'new {{data.classname}}()'
// to create an instance of the class.
// Extend static class: '{{data.classname}}' inherits from static object '{{data.superclassname}}' by:
var {{data.classname}} = {{data.superclassname}};
// The following definitions extend/overwrite the existing attributes and methods of '{{data.superclassname}}'
//--------------------------------------
{{/ifcond}}
{{/ifcond}}
//---------------------------------------------------------------------
//---Attributes: "{{data.classname}}"
//---------------------------------------------------------------------

{{#foreach data.attributes data}}
    // ------------------------------------------
    // {{visibility}}: {{name}}   Class: {{class}}
{{#ifcond comment "!=" ""}}
{{indent comment "    // "}}
{{/ifcond}}
{{#ifcond visibility "==" "public"}}
    {{data.classname}}.{{name}} = {{{init}}};   // Class: {{class}}
{{/ifcond}}
{{#ifcond visibility "==" "private"}}
    var {{name}} = {{{init}}};   // Class: {{class}}
{{/ifcond}}
{{/foreach}}
//---------------------------------------------------------------------
//---Methods of Class "{{data.classname}}()"
//---------------------------------------------------------------------

{{#foreach data.methods data}}

    //#################################################################
    //# {{visibility}} Method: {{name}}()  Class: {{data.classname}}
    //# Parameter:
    //#    {{parameterlist parameter "    //#    "}}
    //# Comment:
{{indent comment "    //#    "}}
    //# {{{returncomment}}}
    //#################################################################

{{#ifcond visibility "==" "public"}}
    {{data.classname}}.{{name}} = function ({{#paramcall parameter}}{{/paramcall}}) {
{{#ifcond data.reposinfo.debugheader "==" "yes"}}
          //----Debugging------------------------------------------
          // console.log("{{filename data.classname}}.js - Call: {{data.classname}}.{{name}}({{#paramcall parameter}}{{/paramcall}})");
          //----Call Function {{name}}()----
          //    {{data.classname}}.{{name}}({{#paramcall parameter}}{{/paramcall}});
          //-------------------------------------------------------
{{/ifcond}}
{{/ifcond}}
{{#ifcond visibility "==" "private"}}
    function {{name}}({{#paramcall parameter}}{{/paramcall}}) {
{{#ifcond data.reposinfo.debugheader "==" "yes"}}
          //----Debugging------------------------------------------
          // console.log("{{filename data.classname}}.js - Call: {{name}}({{#paramcall parameter}}{{/paramcall}})");
          //----Call Function {{name}}()----
          //    {{name}}({{#paramcall parameter}}{{/paramcall}});
          //-------------------------------------------------------
{{/ifcond}}
{{/ifcond}}

{{indent code indent="      "}}
    }
    // ---- Method: {{name}}() Class: {{data.classname}} ------
{{/foreach}}


{{/ifcond}}
{{#ifcond data.reposinfo.require_classes "==" "yes"}}

// NodeJS: export class constructor '{{data.classname}}' for module {{filename data.classname}}.js
// -------
module.exports = {{data.classname}};
{{/ifcond}}
`;

// NodeJS: uncomment modules.export in last line
// module.export = {{classname}};