Documenting Interfaces

There are two main methods we encourage you to use when documenting your interfaces:

1. Commenting your code:

Commenting should be used within your code to provide general guidance on what key blocks in your code accomplishes, to improve readability and knowledge transfer for collaborators.

2. Help documentation for custom functions:

Help Files (*.help) should be used to create detailed documentation for all custom functions used within your interfaces. These help files are accessible to users in the Translator and will also enable auto-completion of arguments for your functions while you are coding.

Help documentation should include:

• An overview of what your function does.

• Optional and required parameters.

• What is expected to be returned.

• A Lua code snippet of a common use case.