sublime-jsdocs icon indicating copy to clipboard operation
sublime-jsdocs copied to clipboard

Option for no leading asterisk

Open amsul opened this issue 10 years ago • 6 comments

Hi there,

Is there a configuration option for creating the template docs without the leading asterisk? I couldn’t seem to find one..

For example:

function method(arg1, arg2) {}

Generates the following:

/**
  [method description]
  @param  {[type]} arg1 [description]
  @param  {[type]} arg2 [description]
  @return {[type]}      [description]
 */
function method(arg1, arg2) {}

The main reason for this is that it allows for easier copying/pasting of code snippets within the comments.

amsul avatar Dec 04 '14 02:12 amsul

This isn't how Java/JS Docs are written in my experience. Is there a tool or some example of a codebase which uses this style?

spadgos avatar Dec 07 '14 16:12 spadgos

Ive seen it in several places. Most notably in ember.js source: https://github.com/emberjs/ember.js/blob/master/packages/ember-application/lib/system/application.js

If this is an extensive request, we are willing to offer a small bounty for it..

amsul avatar Dec 07 '14 17:12 amsul

I'll take a look.

spadgos avatar Dec 07 '14 17:12 spadgos

+1

phun-ky avatar Mar 23 '15 13:03 phun-ky

+1

andrewobrien avatar May 28 '15 12:05 andrewobrien

+1

shinrox avatar Sep 25 '15 20:09 shinrox