[Dear Lazyweb] Google fails me...
...but only because it ignores prefix characters (i.e. "@ignore" isn't distinct from "ignore").
I have some code which is documented in comments. It looks as though these comments are intended to be parsed and compiled into a help document, but I have no idea what's being used. The only clues are these "@" prefixed tags in the comments.
So far I've found : @ignore, @description, @see, @version
A typical comment would be
/**
* Represents a Foo.
* @description
* Here's some explanation of the class and what it's doing
* @see Bar
*/
Anyone recognise this?
I have some code which is documented in comments. It looks as though these comments are intended to be parsed and compiled into a help document, but I have no idea what's being used. The only clues are these "@" prefixed tags in the comments.
So far I've found : @ignore, @description, @see, @version
A typical comment would be
/**
* Represents a Foo.
* @description
* Here's some explanation of the class and what it's doing
* @see Bar
*/
Anyone recognise this?