The core of jQuery doesn't have formal comments, and I don't think there's any standarized documentation among jQuery devs. I always add some *formal* comments in the header of the source version of my plugins. I stick to scriptDoc http://scriptdoc.org/. It's an adaptation of javadoc and it's supported by some IDEs. I think I used it for Aptana, back then when I used that app.
I don't use tags that are not specified, instead I just use words like: Date: 03/02/08, Notes:...., etc. Hope that helped -- Ariel Flesler http://flesler.blogspot.com On Mar 26, 9:53 am, alexanmtz <[EMAIL PROTECTED]> wrote: > Good point stephen, I note this too... > > Im develop a plugin and use javadoc and I create some fields that dont > fit in documentation, but was necessary to describe it... > > I think that the jQuery developers can answer this... > > On Mar 25, 5:34 pm, Stephen <[EMAIL PROTECTED]> wrote: > > > > > 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- Hide quoted text - > > - Show quoted text -
