Skip to content

Documentation comments #669

@lars-reimann

Description

@lars-reimann

Is your feature request related to a problem?

Handling of documentation comments needs to be improved:

  • If the declaration has annotations, the documentation is not associated properly to it.
  • @param is not linked to the appropriate parameter (same for a possible @result/@typeParam...). This information should be shown in the hover provider, for example.
  • No syntax highlighting of special elements inside (e.g. @param).
  • No validation of documentation comments (e.g. info/warning if some but not all parameters are documented).
  • * is not added at the start of lines after pressing enter.
  • * is not removed if lines are joined.
  • Change tag rendering for typeParam, param, and result.
  • Document format

Desired solution

Fix those issues.

Possible alternatives (optional)

No response

Screenshots (optional)

No response

Additional Context (optional)

No response

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueGood for newcomersvalidation ✔️Improved or new static checksvscode 🔨Issues regarding tools like the VS Code extension

    Projects

    Status

    Backlog

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions