Skip to content

JSDoc optional #242

@holtwick

Description

@holtwick

Describe the bug

This is not really a bug, more a request.

With the latest changes @parm and @returns are automatically added on lint:fix. This causes my source code to bloat up. I usually use comments like this in one line to quickly annotate the use case of a functionality and be able to see it then in VSCode as a tooltip. Example:

/** Calculates the sum of `a` and `b` */
function sum(a: number, b: number): number {
  return a + b
}

This now becomes:

/**
 * Calculates the sum of `a` and `b`
 * @param a
 * @param b
 */
function sum(a: number, b: number): number {
  return a + b
}

4 additional lines ;)

Tooltip in VSCode:

20230913-115502-capture-holtwick@2x

Reproduction

See description.

System Info

System:
    OS: macOS 13.5.2
    CPU: (8) arm64 Apple M1
    Memory: 321.00 MB / 16.00 GB
    Shell: 5.9 - /bin/zsh
  Binaries:
    Node: 18.12.1 - ~/.nvm/versions/node/v18.12.1/bin/node
    Yarn: 1.22.19 - /opt/homebrew/bin/yarn
    npm: 9.8.1 - ~/.nvm/versions/node/v18.12.1/bin/npm
    pnpm: 7.17.0 - /opt/homebrew/bin/pnpm
  Browsers:
    Edge: 116.0.1938.76
    Safari: 16.6

Used Package Manager

pnpm

Validations

  • Follow our Code of Conduct
  • Read the Contributing Guide.
  • Check that there isn't already an issue that reports the same bug to avoid creating a duplicate.
  • Check that this is a concrete bug. For Q&A, please open a GitHub Discussion instead.
  • The provided reproduction is a minimal reproducible of the bug.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      pFad - Phonifier reborn

      Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

      Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


      Alternative Proxies:

      Alternative Proxy

      pFad Proxy

      pFad v3 Proxy

      pFad v4 Proxy