Page History
...
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} | Tag indicating the author of the code |
@constructor | @constructor |
|
@deprecated | @deprecated | Tag indicating that the function or variable is obsolete or has been replaced and should be used anymore |
@example | @example | Tag allowing to provide some sample code how to use the function or variable |
@param | @param {Type} name parameterDescription | Tag to describe function parameters |
@private | @private | Annotates a variable or function as accessible only from within the scope1 in which it is declared |
@protected | @protected | Annotates a variable or function as accessible from within the scope 1 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 |
|
1: A scope can be either a Form or the globals scope. Only Form can be extended, thus the @protected tag is not relevant for annotating variables and functions within the globals scope
...
Expression name | Syntax example | Comments | |
---|---|---|---|
Named type | {String} |
| |
AnyType | * |
| |
OR Type | {String|Number} |
| |
REST Type | {...String} |
| |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ee96e5414580764b-e4a87712-40764343-b5aeba09-1a2d0625925f02d1c6e96526"><ac:plain-text-body><![CDATA[ | Array Type | {String[]} |
|
Object Type | {Object<String>} |
| |
<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ac829384d590e7ef-daad9047-4f2a43b4-a94a943d-da5e0b9535f07f4baaef335e"><ac:plain-text-body><![CDATA[ | Object Type with optional properties | { {sDocID:String, [sTemplateID]:String}} |
|
JSFoundSet type | {JSFoundset<db:/udm/contacts>} |
| |
JSRecord type | {JSRecord<db:/udm/contacts>} |
| |
JSDataSet type | {JSDataSet<{name:String, age:Number}>} |
| |
RuntimeForm Type | {RuntimeForm<superFormName>} |
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
| |
|
|
|
...