To use this website fully, you first need to accept the use of cookies. By agreeing to the use of cookies you consent to the use of functional cookies. For more information read this page.

Official ZPE/YASS documentationExternal documentation

External documentation is done using the @ syntax.

This means when the code is compiled, using the -h doc command on the compiled file and requesting the documentation by name will return the text that was allocated to that documentation:

@doc "MyFunction : This function returns true"
function MyFunction ()
  return true
end function

The description must be quoted after the @doc directive. This is available only as of version 1.4.1. Previous versions use a different system.

This kind of documentation can be very useful if you are distributing your compiled code or planning to add it as a library.

Accessing it again is done with the -h ZAC applied on a compiled script.

Command line
zpe -h doc -f file.zex -s $function_name

Prior to version 1.4.1

In older versions of ZPE, internal documentation can be exported using @ commands within multiline comments.

/*@doc My function:This function returns true*/

The colon in the middle splits the documentation into two halves, one for the name (on the left) and one for the description (on the right).

When using the @ commands, the comment must use the multiline comment symbols /* and */.

The standard library (stdLib) contains examples of these directives.

Code previewClose
Feedback 👍
Comments are sent via email to me.