millermedeiros / js-signals

Custom Event/Messaging system for JavaScript inspired by AS3-Signals
http://millermedeiros.github.com/js-signals/
1.97k stars 179 forks source link

maybe remove JSDoc and create only external documentation #16

Closed millermedeiros closed 13 years ago

millermedeiros commented 13 years ago

JSDoc add too much noise to the source code and don't add that much benefits.. variable and methods names are pretty straightforward so most of the comments are redundant... maybe refactor code on a way that comments are almost unnecessary.

advantages of jsdocs :

disadvantage:

millermedeiros commented 13 years ago

probably migrate to joDoc since it have the option to use external markdown files.

millermedeiros commented 13 years ago

I will keep JSDoc since it is already on use and creating an external documentation takes a lot of time...