Marking Up Your Files

Documenting with Compodoc

Currently, the options for documenting your classes with JSDoc are limited when using Compodoc to using only the following tags:

• The @example tag
• The @ignore tag
• The @link tag
• The @param {type} Name Description tag
• The @returns tag

If you’re familiar with using a documentation library such as JSDoc or YUIDoc, this might feel restrictive at first. Surprisingly, this is ...