Servoy 2020 Documentation
Child pages
  • JSDoc Annotations

Versions Compared

Old Version 9

changes.mady.by.user Paul Bakker

Saved on

compared with

New Version 10

changes.mady.by.user Paul Bakker

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

 

 

 

function parameters

/**
 * @param {String} value Just some string value
 */
function demo(value)
{...}

 

function return type

/**
 * @param {String} value Just some string value
 * @return x:Number, y:Number  */
function demo(value) {
   ...
   return {x: 10, y: 20}
}

 

variables

/**
 * @type {XML}
 */
var html = <html>
   <head>
   </head>
   <body>
      Hello World!
   </body>
</html>

 

 

 

 

...

Expression name

Syntax example

Comments

Named type

{String}
{Boolean}
{Number}
{XML}
{XMLList}
{RuntimeForm}
{RuntimeLabel}
{JSButton}
{JSForm}

 

AnyType

{*}

 

OR Type

{String|Number}

 

REST Type

{...String}

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="e047ea67bd590346-dd237e41-4503430d-90ef9a94-8cf47ce551e6028c7d94e500"><ac:plain-text-body><![CDATA[

Array Type

{String[]} 
]]></ac:plain-text-body></ac:structured-macro>
{Array<String>} 
{Array<Byte>}

 

Object Type

{Object<String>} 
{Object<Array<String>>} 
{name:String, age:Number}} 

 

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="ab436c252d23ea3c-5d7790cd-423a4d9e-a2d68320-b165fce03654daa4905ab0d8"><ac:plain-text-body><![CDATA[

Object Type with optional properties

{ {sDocID:String, [sTemplateID]:String}}
]]></ac:plain-text-body></ac:structured-macro>
{ {sDocID:String, sTemplateID:String=}}

 

JSFoundSet type

{JSFoundset<db:/udm/contacts>} 
{JSFoundset<{column1:String, column2:Number}>}

 

JSRecord type

{JSRecord<db:/udm/contacts>} 
{JSRecord<{column1:String, column2:Number}>}

 

JSDataSet type

{JSDataSet<{name:String, age:Number}>}

 

RuntimeForm Type

{RuntimeForm<superFormName>}

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

...