如何在 JSDoc 中创建类别?
How to create categories in JSDoc?
背景
我正在记录我自己的 JS 库,我偶然发现了 lodash 库 ( https://lodash.com/docs/4.17.4 )。
它的文档有一个带有类别(数组、集合等)的侧边栏,每个类别都有函数的文档。
Objective
我希望我的文档使用最新的 JSDoc 版本具有类似的结构。
问题
查了下没找到lodash使用的jsdoc模板。我也找不到类似的功能,也找不到如何使用 JSDOC 复制它。
问题
- lodash 文档使用哪个 JSDoc 模板?
- 如果模板无关紧要,我如何在文档中添加类别?
解决方案
经过大量研究,我得出结论,用 jsdoc 添加 @category
是不可能的。其实很多人都试过都失败了:
以某种方式模拟此行为的唯一方法是使用 @namespace
,但此解决方案有很多缺点并且范围有限:
不过,在支持这样的功能之前,这就是我正在使用的。
我刚刚发布了新版本的 better-docs jsdoc
模板,它支持@category 标签。只需将它添加到您的 class/module/whatever,它就会在侧边栏中命名空间。
只是想分享一个我终于在 Whosebug 上得到的答案。你确实可以添加 @category
标签到你的 JSDoc,你只需要通过配置文件安装这个插件:
背景
我正在记录我自己的 JS 库,我偶然发现了 lodash 库 ( https://lodash.com/docs/4.17.4 )。
它的文档有一个带有类别(数组、集合等)的侧边栏,每个类别都有函数的文档。
Objective
我希望我的文档使用最新的 JSDoc 版本具有类似的结构。
问题
查了下没找到lodash使用的jsdoc模板。我也找不到类似的功能,也找不到如何使用 JSDOC 复制它。
问题
- lodash 文档使用哪个 JSDoc 模板?
- 如果模板无关紧要,我如何在文档中添加类别?
解决方案
经过大量研究,我得出结论,用 jsdoc 添加 @category
是不可能的。其实很多人都试过都失败了:
以某种方式模拟此行为的唯一方法是使用 @namespace
,但此解决方案有很多缺点并且范围有限:
不过,在支持这样的功能之前,这就是我正在使用的。
我刚刚发布了新版本的 better-docs jsdoc
模板,它支持@category 标签。只需将它添加到您的 class/module/whatever,它就会在侧边栏中命名空间。
只是想分享一个我终于在 Whosebug 上得到的答案。你确实可以添加 @category
标签到你的 JSDoc,你只需要通过配置文件安装这个插件: