Giter Club home page Giter Club logo

Comments (3)

micmath avatar micmath commented on May 14, 2024

Another way to do it is

var someObject =
/**
    @constructor
*/
exports.someObject = function() {
}

But in general the doc comment must appear immediately before the thing it documents (unless you provide a @name and then it can appear anywhere you please).

from jsdoc.

jannon avatar jannon commented on May 14, 2024

This might be a good candidate for a plugin. I'll try to look into the possibilities. For now, it's going into the 'future' bucket

from jsdoc.

micmath avatar micmath commented on May 14, 2024

I'm closing this since there is already two ways to do what the poster asks: use @name or split the assignment on two lines so the comment appears immediately before the thing being documented. This is already working as designed.

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.