DocBlockr for Javascript, PHP and CoffeeScript

[Fannon]

Great Plugin!

One suggestion:
If I enter a "one Line comment" like // and I hit enter it will continue to add // to the next line. Most of the time (or always) I have to get rid of those, so they are not too helpful

Usually if I need multiline comments I use /** oder /*. They work fine!

Greets,
Simon

[spadgos]

Hey Fannon,

There is a configuration option for disabling that feature. Just set "jsdocs_extend_double_slash": false in your Base File.sublime-settings (or Preferences.sublime-settings if you're on the dev branch). The other option is to press Shift+Enter and it won't extend the comment.

[Fannon]

Thanks! Exactly what I wanted

[peppy]

Was looking for something exactly like this. It actually does more than I even thought I wanted, too. Thanks so much!

[mpedrummer]

As a feature request - more control over the whitespace, please!

The deep alignment is pretty close, but there's a few differences from what my company's code-sniffing will accept, namely that we don't align the first column with other tags. So, when there's @param and @return, this plugin's deep alignment puts two spaces after the @param, but the code sniffer wants just one.

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

Really, this is awesome, though - not a big deal to fix those myself, and much better than typing out the whole thing!

[spadgos]

hey mpedrummer,

I believe that at least some of your requests are already implemented -- you just need to set a config variable. The docs are in the readme and all the options are documented at the bottom of that page.

jsdocs_align_tags (String) Whether the words following the tags should align. Possible values are 'no', 'shallow' and 'deep'

For backwards compatibility, false is equivalent to 'no', true is equivalent to 'shallow'
'shallow' will align only the first words after the tag. eg:

Code: Select all

@param    {MyCustomClass} myVariable desc1
@return   {String} foo desc2
@property {Number} blahblah desc3

'deep' will align each component of the tags, eg:

Code: Select all

@param    {MyCustomClass} myVariable desc1
@return   {String}        foo        desc2
@property {Number}        blahblah   desc3

I think you'd probably want "jsdocs_align_tags": false here.

For the spacing between sections, I've put that into an issue so I won't forget about it.

[mpedrummer]

Thanks spagdos!

Unfortunately, all three settings aren't quite what we need - which may indicate we should change the code-sniffing standard! Deep alignment is closest - we do align columns, but only within the same tag, not across all tags like deep does. Actually, shallow aligns the first column across all tags, too. "No" means I have to manually align all the columns, which really isn't the end of the world.

I'm going to leave it on "no" for a few days, see what happens there.

Thanks
MPEDrummer

[Grant]

Anyone ventured into adapting this for C++ yet?

[rchl]

Anyone ventured into adapting this for C++ yet?

Is there some adapting needed for C++? I seem to be happy with how it works with C++ here.

EDIT: But it's probably because I haven't seen how it detects parameters and stuff in .js, for example. Until now.

[web559]

This is a beautifully done! Thanks, spadgos.

Is it possible to customize what string to begin tab-completion of the docblock with? I would love to be able to use doc<tab> or //<tab> instead of /**.