- Use modified conventions outlined in Doxygen
Wikipedia Doxygen Article
Doxygen Web Site
- C style comments (/* */) and standard C++ comments (//) are both fine, though the former is discouraged within functions (even for multiple lines, repeat the // single-line comment).
- Custom functions should use, at minimum, the following header
/** * ===================================================== * CustomFunction ( parameter1 ; parameter2 ) * * PARAMETERS: * @parameter1 (text) Input string * @parameter2 (num) Numerical value * RETURNS: * (bool) True or False based on proper * evaluation * DEPENDENCIES: * none * NOTES: * Try to always use the List() function when * passing multiple values into var.eval! * * $checkScriptName is a reserved local * variable used when you wish to enforce * * that inbound parameters match the name of * the script. It is reset after the * * evaluation. * RELEASE: 100917 * ===================================================== * */