Git Product home page Git Product logo

Comments (5)

h13i32maru avatar h13i32maru commented on June 13, 2024

@cristinecula Hi! Thanks this question!
Now, ESDoc supports inline docblocks.
But, @type can not have description text.
Because JSDoc original syntax does not have description text.
Sorry 😓

from esdoc.

mysticatea avatar mysticatea commented on June 13, 2024

So this works:

/** the progress in percentages. @type {Number} */
this.progress = 0

Hmm, ugly a bit :)

from esdoc.

h13i32maru avatar h13i32maru commented on June 13, 2024

@mysticatea Thanks!
But documentation of the code is invalid... ESDoc does not support the style.
2015-08-28 22 13 10

from esdoc.

cristinecula avatar cristinecula commented on June 13, 2024

Thank you for the answer :)

This notation is pretty standard across other documentation tools, but I understand if you want compatibility with JSDoc.

Keep up the good work 👍

from esdoc.

h13i32maru avatar h13i32maru commented on June 13, 2024

Thanks for your understanding.

from esdoc.

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.