Re: [Jsdoc-user] comment syntax

[Jake D. <jak...@ni...>]

Only

/**
My function
@param myparam
*/

is necessary Anthony (notice the two stars /** at the start).  Most
javascript editors will add the stars and indent each line in between,
that's probably why you've seen documentation that looks that way.

Jake

On 3/26/07, Anthony Ettinger <an...@ch...> wrote:
>
> is this really necessary for JSDoc to work?
>
> /**
> *
> *
> *
> *
> *
> */
>
> or is that just format style.
>
> I'd rather just do:
>
> /*
> My description here...
>
> @method Foo();
> @param Bar {String} Refers to the 'bar' object
>
> */
>
>
> Sorry I couldn't just "try it" because I'm not actually using JSDoc yet.
>
>
>
> --
> Anthony Ettinger
> Ph: 408-656-2473
> http://chovy.dyndns.org/resume.html
> http://utuxia.com/consulting
>
> -------------------------------------------------------------------------
> Take Surveys. Earn Cash. Influence the Future of IT
> Join SourceForge.net's Techsay panel and you'll get the chance to share
> your
> opinions on IT & business topics through brief surveys-and earn cash
> http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
> _______________________________________________
> Jsdoc-user mailing list
> Jsd...@li...
> https://lists.sourceforge.net/lists/listinfo/jsdoc-user
>