Movatterモバイル変換


[0]ホーム

URL:


Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

chore: fix / clean up jsdoc comments #1342

Open
Labels
choreGeneral improvementcode qualityCode quality improvementdocumentationPR that adds or fixes docs; issue that points out issues with the docs
@Zatan16

Description

@Zatan16

Motivation

Many people who use libraries not only use help of jsdoc for methods, but also for the parameters. So, moving the jsdoc declaration from beforeclass to beforeconstructor would definitely help many beginners using this library. Then, the descriptions would show up for the parameters as well.

Examples

No response

Possible workarounds

The possible workaround is that instead of moving the jsdoc completely to beforeconstructor, the description can stay beforeclass but the@param needs to be moved to beforeconstructor

Additional information

You don't need to use tags such as@class and@constructor with ES 2015 classes—JSDoc automatically identifies classes and their constructors simply by parsing your code.

as stated by thedocumentation for classes

Metadata

Metadata

Assignees

No one assigned

    Labels

    choreGeneral improvementcode qualityCode quality improvementdocumentationPR that adds or fixes docs; issue that points out issues with the docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


      [8]ページ先頭

      ©2009-2025 Movatter.jp