Hi,
In many jQuery plug-ins and JS code using jQuery, I find comments at
the top of the source code like this:

/**
 * SomeFunction - Some comments.
 * @requires jQuery v1.2 or above
 * @example
 *
*/

This looks like Javadocs to me, but there are certain fields that
don't seem to be in the Javadoc documentation:
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html#tag

Fields like @example and @option are not in the Javadoc
specifications, however.

Is there a URL that discusses how to write jQuery comments like these
plug-in authors are doing?  I attempted to find something on
jquery.com, but I have not found anything or have been searching the
wrong way.

Thank you for reading this.

--Stephen

Reply via email to