search

spadgos / sublime-jsdocs

Simplifies writing DocBlock comments in Javascript, PHP, CoffeeScript, Actionscript, C & C++
MIT License
3.11k stars 276 forks source link

coffeescript - codo support #176

Open cooolbasha opened 11 years ago

cooolbasha commented 11 years ago

Hi,

Can there be a different setting/options available for comment coffeescript for eg single # . This would be helpful for codo style documentation.

thanks

spadgos commented 11 years ago

The single hash comments already get extended with new lines. If you're suggesting that the docblock template be added in this situation:

#<enter>
foo = (bar) ->

...then I'm reluctant to add that, since I don't feel it's a strong enough signal that the plugin should do something in that situation. Compare to other languages, where /** is a strong indicator of intent.

cooolbasha commented 11 years ago

Maybe there should be option in the user setting for coffee files to give the documentation  so instead of 

###*
 * [validate description]
 * @param  {[type]} data [description]
 * @return {[type]}      [description]
###

it could be on the tab #* for coffeescript

#
# [validate description]
# @param  {[type]} data [description]
# @return {[type]}      [description]
#

thanks

Qix- commented 10 years ago

I'm with this. I usually document as

##
# @param {[type]} data [description]
someMethod: (data) ->
   # ...

Having to do ###* using the multi-line comment block is really ugly, personally.

pronebird commented 9 years ago

###* is ugly, can we please change it to default behavior we have in javascript, e.g. triple # in case of CoffeeScript.