_{Official ZPE/YASS documentation}External 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.

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