Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FKITDEV-2352: fix jsdoc #52

Merged
merged 2 commits into from
Aug 21, 2024
Merged

FKITDEV-2352: fix jsdoc #52

merged 2 commits into from
Aug 21, 2024

Conversation

robence
Copy link
Contributor

@robence robence commented Dec 21, 2023

  • use correct syntax and existing types

https://youtrack.techteamer.com/issue/FKITDEV-2352/MQ-JSDoc-kiegeszites

  • * @typedef {import('./QueueConnection')} QueueConnection
    tipusdefinicio után oldódik fel az alábbi hivatkozás:
    * @param {QueueConnection} queueConnection

  • @returns a helyes syntax

  • typeof keyword-el adható meg osztály referencia

/** @type {typeof QueueMessage} ResponseMessageModel - The class reference for the QueueMessage model. */
    this.ResponseMessageModel = ResponseMessageModel

- use correct syntax and existing types
@tunderdomb
Copy link
Contributor

Egy ideje ez probléma jsdocban. Sajnos ez egy limitációja. Illetve tudjuk, hogy nem frissítik és tartják karban.
jsdoc/jsdoc#1349

Amit csináltál akkor jó, ha mindkét IDE-ben, dependencyként használva működik az intellisense.

@robence
Copy link
Contributor Author

robence commented Dec 22, 2023

az intellisense működése eltér az egyes programokban, ezt összefüggőnek látom a jsdoc-al. Most már látom hogy a typeof nem szabvány itt, ezért nem is működik webstormban. Az első két pontot a pr leírásból kezeli a jetbrains és a vscode.

vscode

  • kezeli a függvényben felismert visszatéréi értéket és képes a hívás láncban levő többi függvényre is kiterjeszteni
  • pontos találatot és tipusokat ad

webstorm

  • jól működik a függvény alapú keresés, és hamar felsorolja az ilyen nevű fn signature-öket több packageből
  • kód nélkül képes erre, még amikor a változó az any akkor is

a végeredmény hasonló a két esetben, elérhető a függvények közötti navigáció és kódkiegészítés


Screenshot from 2023-12-22 15-16-26
Screenshot from 2023-12-22 15-16-46
IMG_1781
IMG_1782
IMG_1783

@robence robence requested review from wahur666 and removed request for tbence94 August 15, 2024 07:44
@wahur666 wahur666 changed the base branch from master to beta August 21, 2024 09:37
@wahur666 wahur666 merged commit 5efbf4f into beta Aug 21, 2024
1 check passed
@wahur666 wahur666 deleted the FKITDEV-2352/jsdoc-fixes branch August 21, 2024 09:39
github-actions bot pushed a commit that referenced this pull request Aug 21, 2024
## [7.0.4-beta.1](7.0.3...7.0.4-beta.1) (2024-08-21)

### Bug Fixes

* jsdoc ([#52](#52)) ([5efbf4f](5efbf4f))
github-actions bot pushed a commit that referenced this pull request Aug 27, 2024
## [7.0.4](7.0.3...7.0.4) (2024-08-27)

### Bug Fixes

* jsdoc ([#52](#52)) ([5efbf4f](5efbf4f))
* trigger npm release ([#71](#71)) ([79dad66](79dad66))
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants