RFC: Core set of tags for TSDoc

TSDoc should define a core set of tags for very common scenarios, so their semantics can be standardized across all tools.

Ignoring the syntax details for a moment, which tags should be included in this list?

Here’s some suggestions from AEDoc:

• @param
• @returns
• {@link}
• {@inheritdoc}
• @remarks

Any others?

[octogonz]

Seems reasonable. However strict mode should enforce that @see always appears at the start of a line, and always after the main content. Before we eliminated it, we found a lot of people writing this kind of thing:

/**
 * The `Widget.render()` method draws the widget.  @see the {@link IRenderable}
 * interface for more about rendering.  It has more info about stuff you might like
 * 
 * Blah blah...
 */

[BnayaZil]

Please consider: async public private