Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 855 Bytes

AUTODOCSTD.md

File metadata and controls

31 lines (21 loc) · 855 Bytes

Autodocumentation standard on the Med3Web project

It is required to keep autodocumentation standard JSDOC from the very early stage of the development process. This is important action to make project source code more understandable, buggy free and easy maintainable in the future.

Good JSDOC tutorial can be used to make your autodocumentation better.

Source file beginning

In the fist rows of source text file (with *.js extension) you need to add keyword @module

/**
* KTX header structure descriptor
* @module app/scripts/loaders/ktxheader
*/

Class description

Before class description start it is required to add special comment with keyword @class

/**
* Class KtxHeader represent header for KTX file
* @class KtxHeader
*/