spadgos / sublime-jsdocs

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

Configurable spacing between sections #46

Open spadgos opened 12 years ago

spadgos commented 12 years ago

From the forum:

a newline after the descriptions, but no newline before the @return tag.

joeytrapp commented 12 years ago

+1 for something like this. I'd like to have a extra newline between the description and the @ options (but no newline between the @ options).

levacic commented 10 years ago

Another +1 for this feature.

I currently have jsdocs_spacer_between_sections set to false, and manually add a blank line after the description. This is, however, tedious, especially when reformatting docblocks (via ALT+Q on Windows), and a lot of code I've seen uses this type of spacing (even across different languages), so it would be useful to have DocBlockr do it automatically.

Maybe the setting could be jsdocs_spacer_after_description or something like that? If jsdocs_spacer_between_sections is true, it would obviously override this setting, but otherwise, an empty line should be added after the description, but not between the other sections.