search

cwilson1031 / jsdoc-toolkit

Automatically exported from code.google.com/p/jsdoc-toolkit
0 stars 0 forks source link

Inconsistent delimiters for multiple types #296

Closed GoogleCodeExporter closed 9 years ago

GoogleCodeExporter commented 9 years ago 
When specifying multiple types in a @type tag, you must delimit the entries 
with a pipe character. However, when delimiting multiple types in a @param or 
@returns tag you must delimit with a comma.

Why can't you use either delimiter in either tag? I'd just like it consistent 
in my doc comments :-)

Cheers

Original issue reported on code.google.com by apritch...@gmail.com on 27 Jul 2010 at 4:18

Attachments:

GoogleCodeExporter commented 9 years ago 
"when delimiting multiple types in a @param or @returns tag you must delimit 
with a comma."

Not true. You can use pipes or commas. In fact you can mix and match, and use 
both pipes and commas in the same param or return if you really wanted.

Commas as type delimiters will not be supported in JSDoc 3, so I'd recommend 
standardizing on pipes now if you can.

Original comment by micmath on 27 Jul 2010 at 5:00