my-doc-jsx-plugin-api — это плагин для my-doc-jsx, который используется для создания документации API.

Установка

Для установки плагина с npm выполните следующую команду:

npm install my-doc-jsx-plugin-api --D

Чтобы интегрировать плагин в nodejs или браузер, используйте метод myDocJsx. В случае с nodejs:

const Plugin = require('my-doc-jsx-plugin-api')
myDocJsx.usePlugin(new Plugin)

В браузере:

myDocJsx.usePlugin(new myDocJsxPluginAPI())

При использовании в среде cli:

docjsx c html --plugin my-doc-jsx-plugin-api index.jsx ./

Генерация документации по комментариям функций

Эта функция позволяет создавать документацию по функциям на основе комментариев. Документация представляет собой таблицу, которая описывает назначение функции, параметры и возвращаемые значения. Пример использования:

<api>{`
* 根据字符串模糊查询key，并返回匹配的缓存数组
* @param {string} searchText    key的模糊检索条件
* @return {Array<string>}      返回匹配的数组
`}</api>