Page History
...
| Code Block |
|---|
/**
* A simple demo function that outputs some text
* @author pbakker
* @private
*
* @param {String} text The text that will be written to the output
* @throws (String)
* returns Boolean
*
* @example try {
* saySomething('Hello world!');
* } catch(e) {
*
* }
*
* @see application.output
* @since 1.0
* @version 1.0.1<br>
* - Added some more JSDoc tags for the demo
*/
function saySomething(text) {
if (text == null || text.length == 0) {
throw "Invalid input!"
}
application.output(text);
return true;
}
|
...
Tag | Syntax & Examples | Context | Impact | Description |
|---|---|---|---|---|
@AllowToRunInFind | @AllowToRunInFind | function | Determines if the function will be executes in FindMode when used as an event handler | 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 | function, variable |
| Indicates the author of the code |
@constructor | @constructor | function |
| ... |
@deprecated | @deprecated | function, variable | Accessing a deprecated variable or calling a deprecated function will produce a builder marker in Servoy Developer | Indicates that the function or variable is obsolete or has been replaced and should be used anymore. |
@example | @example | function |
| Tag allowing to provide some sample code how to use the function or variable. Multiline content is possible my including "<br>" as line-breaks behind each line of content |
@param | @param {Type} name parameterDescription | function | Builder markers will be generated in Servoy Developer if the function is called with values for the parameters that do no | Describe function parameters. |
@private | @private | function, variable | Accessing a private variable/function from outside the scope in which it is declared will generate a builder marker in Servoy Developer | Annotates a variable or function as accessible only from within the scope in file in which it is declared |
@protected | @protected | function, variable | Accessing a protected variable/function from outside the scope in which it is declared or a child scope will generate a builder marker in Servoy Developer | Annotates a variable or function as accessible from within the scope in same file in which it is declared and all scopes files that extend this scope file |
@return | @return {Type} | function | The specified type is used by the build process to determine the correctness of the code that uses the returned value | Annotates the type of the returned value. |
@returns | @returns {Type} | function | see @return | alias for @return |
@see | @see seeDescription | function, variable |
| Tag to provide pointers to other parts of the code that are related |
@since | @since versionDescription | function, variable |
| Tag to provide information about in which version of the code the variable or function was introduced |
@SuppressWarnings | @SuppressWarnings (warnings) | function | Stop the generation of builder markers in Servoy Developer for the specified warnings | Custom Servoy JSDoc tag to suppress builder markers of a certain type within a function. |
@throws | @throws {Type} | function |
| Tag to describe the type of Exceptions that can be raised when the function is called. |
@type | @type {Type} | variable, inline variable | The specified type is used by the build process to determine the correctness of the code that uses the variable | Tag to specify the type of the value that a variable can hold. |
@version | @version versionDescription | function, variable |
| Tag to provide information about the version of the code |
A scope file can be either a Form or JavaScript file or the globals scopeJavaScript file. Only Form can be extended, thus the @protected tag is not relevant for annotating variables and functions within the globals scopeJavaScript file
Type Expressions
Type Expressions are used to describe the type and/or structure of data in the following cases:
...
Overview
Content Tools
Activity