как написать описание параметра для потока и документации

Question

как написать описание параметров для потока и документации

Я испробовал множество методов, в настоящее время выполнимый способ может работать только с jsdoc

export default class MyClass {
  /**
   * @param priority description
   */
  static add(
    priority: number, 
    handler: Handler
  ): MyClassAdd {
    return {
      priority,
      handler
    }
  }
}

Answer 1

Мне не совсем понятно, в чем проблема, но у меня есть два предположения: либо JSDoc не работает, потому что он не может проанализировать код с аннотациями типа Flow, либо вы пытаетесь найти способ объединить потоки аннотации JSDoc, поэтому вам не нужно писать их дважды.Я дам вам три возможных решения.

Если проблема в том, что JSDoc выдает ошибки синтаксического анализа, вам необходимо либо предварительно обработать код для удаления аннотаций типа Flow перед запуском JSDoc, либо переместить аннотации Flow в комментарии,Вы можете следовать инструкциям в этом ответе, чтобы добавить шаг предварительной обработки:

https://stackoverflow.com/a/39364639/103017

Или вы можете скрыть аннотации Flow в комментариях, используя этот синтаксис:

export default class MyClass {
  /**
   * @param priority description
   */
  static add(
    priority/*: number */, 
    handler/*: Handler */
  )/*: MyClassAdd */ {
    return {
      priority,
      handler
    }
  }
}

Если вы пытаетесь избежать написания двух наборов аннотаций, вы можете попробовать использовать flow-jsdoc , который генерирует аннотации Flow из аннотаций JSDoc.