What is the name of "/** Some documentation comment **/" Syntax?

Vote count:

0

I've heard the term "docstring" used to describe the JavaDoc/JSDoc/etc. style of multi-line comment:

/**
 * I'm a documentation comment
 */

However, I recently learned that I was hearing this term misused, and that an actual "docstring" is documentation within a literal string, the way Python does it:

def foo():
    '''I'm a real docstring'''

So my question is, is there a term I can use to describe a multi-line comment with an extra asterisk after the opening one and asterisks at the beginning of each line (used for documentation)?

Bonus Question: I also recently learned that the leading asterisks aren't actually required by some tools (eg. JSDoc), and so:

/**
 I'm a documentation comment
 */

is also valid. Is there any sort of term to distinguish "loose" (no leading asterisks required) multi-line documentation comments from "strict" (asterisks required) comments?

P.S. I did try both Googling and searching here, but unfortunately "/**" doesn't search well.

asked 1 min ago

machineghost

11.3k

What is the name of "/** Some documentation comment **/" Syntax?