Skip to content

/* unbuffered Multiline Comments syntax */ for JSDoc #2012

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
quangv opened this issue Jan 6, 2012 · 1 comment
Closed

/* unbuffered Multiline Comments syntax */ for JSDoc #2012

quangv opened this issue Jan 6, 2012 · 1 comment

Comments

@quangv
Copy link

quangv commented Jan 6, 2012

Okay so JSDoc syntax is awesome.

MyClass = Class.create(
  {
    /**
     * Description of constructor.
     * @class Description of class.
     * @constructs
     */
    initialize: function(arg0, arg1) {
    },
  }
);

As discuss on #782 you can simply do something like

class MyClass
    ###*
    Description of constructor.
     @class Description of class.
     @constructs
    ###
    constructor: (arg0, arg1)->

Looks good...

But when I thought about it, for production code you might not want your inline documentation to show... CoffeeScript has no way of supporting unbuffered multi-line comments.

How about /* ... */ for unbuffered multi-line comments?

There's


related: #1350, #1925

@jashkenas
Copy link
Owner

You minify your production code ... which should strip all non-license comments. CoffeeScript doesn't need to strip them for you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants