Giter VIP home page Giter VIP logo

Comments (7)

spadgos avatar spadgos commented on July 19, 2024

One issue is that (AFAIK) coffeescript doesn't support multi-line comments. At least, this doesn't work in the online 'try coffeescript' emulator:

/**
 * foo
 */

Error: unexpected 'math'.

This would make it a much larger change to the code. I'll still look into it, just don't hold your breath. :p

from sublime-jsdocs.

mraxilus avatar mraxilus commented on July 19, 2024

From my understanding, CoffeeScript's multiline comments are as such:

###*
  * foo
###

Which would generate to:

/**
 * foo
 */

from sublime-jsdocs.

spadgos avatar spadgos commented on July 19, 2024

gah, ugly! ok, well anyway, that makes it a bit easier at least.

from sublime-jsdocs.

mraxilus avatar mraxilus commented on July 19, 2024

Yeah... I'm not sure why they went with '#' instead of '//' and '/*'.

from sublime-jsdocs.

spadgos avatar spadgos commented on July 19, 2024

Kids these days...

from sublime-jsdocs.

spadgos avatar spadgos commented on July 19, 2024

This has been added in version 2.6.0. I don't use CoffeeScript myself, so please do let me know how it goes.

from sublime-jsdocs.

artsyca avatar artsyca commented on July 19, 2024

Hi! Sorry to jump in on such an old issue, but it's related to this issue here: yui/yuidoc#56

As these comments are very useful for yuidoc, there's an issue with the yuidoc parser understanding comments with leading *

In other words (to summarize the issue above):

DocBlockr generates comments that look like:

###*
 * @method methodName
 * @param {String} foo Argument 1
 * @param {Object} config A config object
###

Yuidoc expects comments that look like:

###*
# @method methodName
# @param {String} foo Argument 1
# ...
###

or:

###*
@method methodName
@param {String} foo Argument 1
...
###

Is there any way to change the default output of DocBlockr? (I'm also asking the converse of yuidoc..)

Hoping we can come to a good compromise!

from sublime-jsdocs.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.