Как получить генерацию jsdoc для пар методов классов, которые используют функции стрелок?

Question

Я студент, который заканчивает обучение в рамках проекта / работы в рамках capstone. Я работаю над созданием технической документации для передачи следующей команде, которая продолжит эту работу, но я наткнулся на загадку.

Мои методы класса, использующие функции стрелок, не генерируют документацию paramsкогда я создаю документацию с использованием инструмента jsdoc.

, т.е.: становится

Документация работает так, как задумано вVisual Studio Code / Intellisense:

Я искал, пытаясь выяснить, в чем проблема, но я ничего не нашел.

Я имею в виду, что мои исследования дали:

• Устаревший способ заставить vscode играть хорошо с синтаксисом функции стрелок: (https://github.com/Microsoft/vscode/issues/36283) (https://github.com/Microsoft/vscode/issues/22264) ((Это актуальная проблема)где была добавлена ​​поддержка) https://github.com/microsoft/TypeScript/issues/14134)
• Устаревшая информация о поддержке jsdoc для этой функции: https://github.com/jsdoc/jsdoc/issues/1310
• и т. д. и т. д., опять же, ничего полезного.

Следует отметить, что я использую плагин jsdoc-export-default-interop, чтобы jsdoc фактически генерировал tпетли для export default [CLASS OR FUNCTION].

Answer 1

Я нашел решение, которое соответствует моим требованиям

Однако, хотя оно достаточно хорошо для моих целей, я не совсем уверен, что оно точное и будет рада услышать критику, мнения других людей ирешения. Я объясню проблемы, которые у меня есть в конце.

Проблема: похоже, jsdoc не может автоматически определить, является ли назначение элемента функцией при разборе.

Я понятия не имею, почему VSCodeможет обнаружить его автоматически, но, похоже, инструмент JSDoc не может. Здесь указано в официальной документации Ссылка на документацию: (https://jsdoc.app/tags-function.html)

Решение: Документируйте элемент с тегом @function (или псевдонимом, подобным @method).

Путем документирования члена класса с помощью тега @function следующим образом:

Я могу получить функцию стрелки для генерации в видеМетод класса и получите документацию по параметрам:

Мои проблемы

Что ж, самое большое беспокойство / раздражение сейчас, мне нужно просмотреть весь исходный код и добавить@function тегов

Другая проблема в том, что я мог неправильно понять проблему / я не совсем уверен, что это лучшая практика.

И яне слишком уверен, что эта документация точна с точки зрения того, есть ли на самом деле ощутимая разница между функцией стрелки члена класса и методом класса, который мне нужно зафиксировать в документации API.

В любом случае, я думаю, что этобудь то, что я иду с, но я буду контролироватьэтот ответ для прочтения любого ввода / отзыва :)