[IPython-dev] Javascript comments

Brian Granger ellisonbg at gmail.com
Fri Oct 24 14:02:00 EDT 2014

This all just makes me realize how rotten JS is :(

On Thu, Oct 23, 2014 at 1:04 PM, Jonathan Frederic <jon.freder at gmail.com> wrote:
> 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:
> http://blog.fusioncharts.com/2013/12/jsdoc-vs-yuidoc-vs-doxx-vs-docco-choosing-a-javascript-documentation-generator/
> 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.
> Cheers,
> Jon

Brian E. Granger
Cal Poly State University, San Luis Obispo
@ellisonbg on Twitter and GitHub
bgranger at calpoly.edu and ellisonbg at gmail.com

More information about the IPython-dev mailing list