Giter Site home page Giter Site logo

Comments (4)

jonschlinkert avatar jonschlinkert commented on May 14, 2024 2

It's always "the thing between the end of type and start of description.

Only on certain tags. Which is irritating, because it's not documented well. There is no official specification that I'm aware of. I tested hundreds of tags against 5 or 6 popular libs and the results were inconsistent.

from parse-comments.

jonschlinkert avatar jonschlinkert commented on May 14, 2024 2

I'll try later the whole v1 to see what's done.

Great! Fwiw you might find this helpful: https://github.com/jonschlinkert/parse-comments/blob/master/docs/content/comparison.md. The "type" parsing was one of the most complicated parts of this.

from parse-comments.

jonschlinkert avatar jonschlinkert commented on May 14, 2024

In a future version, you will be able to customize this to be like js-doc. Although I personally dislike that format because it's not clear to readers or parsers what's really intended. There are always exceptions where js-doc is wrong.

from parse-comments.

tunnckoCore avatar tunnckoCore commented on May 14, 2024

it's not clear to readers or parsers what's really intended

What's not clear? It's always "the thing between the end of type and start of description. Whatever it be, it's always between two spaces.

I'll try later the whole v1 to see what's done.

from parse-comments.

Related Issues (16)

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.