documon/more/200.Comment Authoring Guide/240.Comments in Comments.md

A documentation system for mortals. Use with any language.

# Comments in comments

To include /* style comments in your comments, HTML-entity-ize the slash:

For example to render this:

    /**
    Something for B
    @method something
    */

... you would write:

/**
Something for B
@method something
*/

... because we are HTML encoding the "/" as "/"

NOTE: It was super tricky to write this explaination, that's why the above is not in a code-block.