search

senchalabs / jsduck

Simple JavaScript Duckumentation generator.
http://docs.sencha.com/
GNU General Public License v3.0
1.5k stars 238 forks source link

What is the correct JSDuck syntax for a local variable? #656

Open zack7498 opened 7 years ago

zack7498 commented 7 years ago

as title,What is the correct JSDuck syntax for a local variable??

I need to explain the purpose of some of the local variables

I used @property,but It's not like local variables,it was more like global variable

nene commented 7 years ago

The main goal of JSDuck is to provide public API documentation. There is no syntax for documenting local variables.

If you want to, you can implement a custom tag for documenting variables. See the wiki.

zack7498 commented 7 years ago

OK, Thank you~