Page History
...
Using the JSDoc plugin hosted on ServoyForge it is also possible to generate HTML documentation of the JavaScript code in a Solution, based on the JSDOc supplied.
| Stoc |
|---|
What Does JSDoc Consist Of
The JSDoc syntax consists of a set of JSDoc tags, contained in JSDoc comments.
...
| Code Block |
|---|
/**
* A simple demo function that outputs some text
* @author Tom
* @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;
}
|
Where Does JSDoc Come From And Which Syntax Is Supported
JSDoc is not a official standard, but the defacto standard is is defined by the JSDoc Toolkit project. The other major definer of JSDoc is Google Closure Compiler's support for JavaScript annotation.
...
See Annotating JavaScript using Using JSDoc and Annotating JavaScript using Using JSDoc below for the supported tags and their syntax.
Working With JSDoc In The Script Editor
As mentioned in the intro, the Script Editor in Servoy Developer utilizes JSDoc to improve the quality of code completion and validation.
...
Note that the Script Editor will always generate a JSDoc comment block with a @properties tag when saving the Script editor, if no JSDoc comments have been defined. The @properties tag is a tag containing information for Servoy to provide proper linking and versioning.
JSDoc Tags
The following JSDoc tags are supported in the Script Editor. This means that the JSDoc tags will be rendered without the "@" sign when hovering over a reference tot he function or variable.
...
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 | none | Indicates the author of the code |
@constructor | @constructor | function | This will show a different icon on the Script Outline view and suppresses warnings related to inconsistent return values when building in a fail-save to calling a constructor function without the new keyword |
|
@deprecated | @deprecated description | 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. |
| @enum | @enum
| variable | none in scripting, but Servoy Relations | Variables that contain a JavaScript Object with key/value pairs and tagged as enumeration using the @enum tag are handled special for Servoy relations: In the relation editor allows selecting one of the keys of the object as value for the primary 'key' in a relation items. String and Number values are supported. They are treated as constants, so changes to the values in scripting are not supported, as in the relation that is loaded will not be updated accordingly. |
@example | @example | function, variable | none | Tag allowing to provide some sample code how to use the function or variable. Multiline content is possible by including "<br>" as line-breaks behind each line of content. |
@override | @override | functions | none | Tag to describe that the function is overriding an equally named function on a super form |
@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 not match the specified types | Describe function parameters. |
| @public | @public | function, variable | Explicitly marks a member as public API. | A member that is not marked as either public, private or protected is implicitly considered as public. Cannot be used in combination with @private or @protected |
@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 file in which it is declared Cannot be used in combination with @public or @protected |
@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 same file in which it is declared and all files that extend this file Cannot be used in combination with @public or @private |
@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 and offer Code Completion | Annotates the type of the returned value. |
@returns | @returns {Type} | function | see @return | alias for @return |
@see | @see seeDescription | function, variable | none | Tag to provide pointers to other parts of the code that are related |
@since | @since versionDescription | function, variable | none | Tag to provide information about in which version of the code the variable or function was introduced |
@SuppressWarnings | @SuppressWarnings ([deprecated], [hides], [wrongparameters], [undeclared], [unused], [nls]) | 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 |
@this | @this {Type} | function | The specified type is used by the build process for the "this" object available inside functions to determine the correctness of the code that uses the object and offer Code Completion | Tag to specify the type of the "this" object inside functions. |
@throws | @throws {Type} | function | none | Tag to describe the type of Exceptions that can be raised when the function is called. |
@type | @type {Type} | variable, inline variable, (function*) | The specified type is used by the build process to determine the correctness of the code that uses the variable and offer Code Completion | Tag to specify the type of the value that a variable can hold. |
| @typedef | @typedef {Type} | variables | Variables tagged using the @typedef JSDoc tag are considered definitions of types. These types can be used as type in other JSDoc tags by using the name of the variable | |
@version | @version versionDescription | function, variable | none | Tag to provide information about the version of the code |
A file can be either a Form JavaScript file or the globals JavaScript file. Only Form can be extended, thus the @protected tag is not relevant for annotating variables and functions within the globals JavaScript file
Type Expressions
Type Expressions are used to describe the type and/or structure of data in the following cases:
...
1 the value in between <..> is the datasource notation that is built up of the database server and tablename: db:/{serverName}/{tableName}
Type Casting
JSDoc can be used inside JavaScript code to specify the type of variables. This can be necessary if the correct type can't be automatically derived.
...
Overview
Content Tools
Activity