When writing Servoy Developer IDE
The Script Editor in the Servoy Developer IDE supports annotating JavaScript code using JSDoc. Documenting the code is a good practise, as it makes it easier to understand the code after a while or if another programmer needs to have a look at it.
Within Servoy, there is
The JSDoc syntax supported by the Servoy Developer IDE is derived from the JSDoc Toolkit and Google Closure Compiler's support for JavaScript annotation, plus some custom Servoy extensions.
The JSDoc syntax consists of a set of JSDoc tags. Some of these tags require a Type Expression as one of the parameters.
JSDoc:
/**
*
*
*/
Auto generated tempaltes
Control-Shift-J
Code Completion
Tag |
Syntax & Examples |
Comments |
---|---|---|
@AllowToRunInFind |
@AllowToRunInFind |
Custom Servoy JSDoc tag to annotate a function that it can be run if the Form on which the function is ran is in FindMode |
@author |
@author {userName} |
|
@constructor |
@constructor |
|
@deprecated |
@deprecated |
|
@example |
@example |
|
@param |
@param {Type} name parameterDescription |
|
@private |
@private |
Annotates a function as accessible only from within the scope in which it is declared |
@protected |
@protected |
Annotates a function as accessible from within the scope in which it is declared and all scopes that extend this scope |
@return |
@return {Type} |
|
@returns |
@returns {Type} |
alias for @return |
@see |
@see seeDescription |
|
@since |
@since versionDescription |
|
@SuppressWarnings |
@SuppressWarnings (warning) |
Custom Servoy JSDoc tag to suppress builder markers of a certain type within a function |
@throws |
@throws {Type} |
|
@type |
@type {Type} |
|
@version |
@version versionDescription |
|
Type Expressions are used to describe the type and/or structure of data in the following cases:
|
|
|
---|---|---|
function parameters |
/** Unknown macro: {...}
|
|
function return type |
/** Unknown macro: {x}
Unknown macro: {\ ...\ return
Unknown macro: {x} \ }
|
|
variables |
/** |
|
|
|
|
A Type Expression is to always be surrounded by curly braces: {typeExpression}. Note that when using the Object Type expression variation that start and stops with curly braces as well, this results in double opening and closing braces.
Expression name |
Syntax example |
Comments |
---|---|---|
Named type |
{String} |
|
AnyType |
* |
|
OR Type |
{String|Number} |
|
REST Type |
{...String} |
|
Array Type |
{String[]} |
|
Object Type |
{Object<String>} |
|
Object Type with optional properties |
|
|
JSFoundSet type |
{JSFoundset<db:/udm/contacts>} |
|
JSRecord type |
{JSRecord<db:/udm/contacts>} |
|
JSDataSet type |
{JSDataSet<{name:String, age:Number}>} |
|
RuntimeForm Type |
{RuntimeForm<superFormName>} |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Adding whatever tag you like
Code completion
JSDoc Templates
Tip: Check out the JSDoc plugin for Servoy Developer on ServoyForge
Old 5.x style of annotating:
JSRecord:servername.tablename
JSFoundset :servername.tablename
Form:formname