Skip to content

Documenting DART

If you contribute code to DART, please document it for the sanity of the people who will maintain it. DART uses JSDoc to generate the DART API documentation. Look at the source code for examples of how we use JSDoc.

In addition to documenting your API methods, you should comment sections of your code in which the logic or behavior is not obvious.

Always code as if the guy who ends up maintaining your code will be a violent psychopath who knows where you live. -- John F. Woods