jon.freder at gmail.com
Thu Oct 23 16:04:59 EDT 2014
As a follow up of today's meeting, it looks like, if we don't mind the
comment appearing before the function, JSDoc allows for our own doc string
format (see simplest case): http://usejsdoc.org/about-getting-started.html
. JSDoc claims to be "highly extensible" and has a markdown plugin
distributed with it. Here's a good article comparing the 4 most popular JS
comment -> API doc tools:
My preference is for JSDoc, but I'd like to hear what others think. Also
the option to NOT use a comment -> doc parser still exists. Provided we
can commit to keeping a separate API docs by hand.
-------------- next part --------------
An HTML attachment was scrubbed...
More information about the IPython-dev