disnet/contracts.coffee — Issue #22: Use comment tag instead?
Author: johnnywengluu
Created: 2012-01-05 20:34:00+00:00
State: open

After having had a lot of problems making this to work I wonder if it's a better idea to use it as a comment tag instead?

Eg.

# @param {Number} number Some description

In this way you don't have to remove the lines when using original coffeescript or browserify. Since if you have thousands of assertions you don't want to remove them or comment them out manually, just to reverse them again when you need them.

Also this would be compatible with:

http://code.google.com/p/jsdoc-toolkit/wiki/TagReference

And you just do the same in JS source.

What do you think?