Skip to content

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

Closed
@quangv

Description

@quangv

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

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions