Giter Site home page Giter Site logo

Comments (1)

micmath avatar micmath commented on May 5, 2024

Are you asking if it is possible to write JSDoc comments without following the standard convention of starting with /** and ending with */?

The slash-star-star convention is inherited from javadoc and is also used in other automated API documenters like phpdoc. It's also recognised by code-completers, like certain versions of the Eclipse IDE and others. It's so well established that I would recommend you follow it too, unless you have a very good reason not to.

That said, I once wrote a plugin for JSDoc 3 that would allow you to use a different syntax, and I suppose you could adapt that to handle some other kind of comment if you wanted.

see https://github.com/micmath/jsdoc/blob/master/plugins/commentConvert.js

from jsdoc.

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.