"@something" words in comments?

Question

What for are these "@word" in comments?

I've seen those in JavaScript and some other languages. Is there some standards with this or is it specially for something specific tool? Can someone open this more advanced commenting process if there is more things similar to this one. And secondly why this example starts with two asterisk mark?

Example:

/**
 * Builds an absolute Path for a project, where
 * the files should be stored
 *
 * @param projectDir String
 * @param fileName String (optional)
 * @return {String} absolute Path
 */

`@param` is the parameter to the function/method, `@return` is the return value, `@author` is the name of the author who written the class/method/module, `@module` is the name of the module whose part the current function is, ... The names are self-explanatory — Tushar, Oct 30 '15 at 17:32

score 2 · Accepted Answer · answered Oct 30 '15 at 17:49

It may look like just aesthetic commenting with some pre-formatted conventions.

But these comments are actually used by development tools to provide automated documentation generation (like JSDoc), syntactic and type checking, or even to get compilation directives (Google Closure minifier).

Both the 2 asterisks and the @something notations are conventions for these development tools.

So if you will never use such development tools, this notation is purely aesthetic. But if you were to use these tools, then it becomes part of your workflow to leverage automated processes.

score 1 · Answer 2 · answered Oct 30 '15 at 17:34

1

No, there is no standard, but one of the most popular tools for that style of documentation comment is JSDoc, which is loosely based on Java's JavaDoc comments.

answered Oct 30 '15 at 17:34

T.J. Crowder

1,031,962
187
1,923
1,875

"@something" words in comments?

2 Answers2