Documentation JavaScript code
Attribute(s)
Documentation
Description
All JavaScript code must be properly documented. The required code documentation standards are described in the Details field.
Motivation
Properly documented code is a prerequisite for an easy to support application.
Example / Details
Script code must be thoroughly documented to allow for an easy determination as to what each section of script does. The most important issue in documentation is to write your documentation in a functional way: what the function of the scriptcode is and why you are doing it.
Two forslashes (//) are used to designate code as being remarks or documentation. The color of the remarks placed after the forslashes will always be in green.
The documentation can be placed on a separate line or on the same line as a line of code (to the right of the code).
The following information should be included in each module of scriptcode:
The purpose of the function
Description of the used parameters
Description of the return value
The original programmer
The date the code was created
The date of change
The author of the change
A short description of the change
Use the following template for your function documentation
/*
**********************************************************************************************************************
<Purpose>
Parameters:
<Parameter1>= <Description of parameter1>
<Parameter2>= <Description of parameter2>
<Parameter3>= <Description of parameter3>
Returnvalue:
Original Author: <Author Name>
Creation Date: <dd>-<mm>-<yyyy> (dd-mm-yyyy)
**********************************************************************************************************************
Change Overview:
Date Programmer Description of Change
**********************************************************************************************************************
*/
Examples:
JS_Inline_Documentation.jpg