我正在记录我自己的JS库,我偶然发现了lodash库(https://lodash.com/docs/4.17.4)。
它的文档有一个带有类别(Array,Collection,ect)的侧栏,每个侧栏都有这些函数的文档。
我希望我的文档使用最新的JSDoc版本具有类似的结构。
调查后我找不到lodash使用的jsdoc模板。我也找不到类似的功能,也没有找到如何使用JSDOC复制它。
答案 0 :(得分:1)
经过大量研究后我得出结论,用@category
添加jsdoc是不可能的。事实上,许多人曾经尝试过并且失败了:
以某种方式模拟此行为的唯一方法是使用@namespace
,但此解决方案的缺点很多且范围有限:
但是,在支持这样的功能之前,这就是我正在使用的功能。
答案 1 :(得分:1)
我刚刚发布了better-docs jsdoc
模板的新版本,它支持@category标签。只需将其添加到您的类/模块/任何内容中,它将在边栏中命名空间。
答案 2 :(得分:0)
只是想分享一个我终于在 stackoverflow 上得到的答案。你确实可以在你的 JSDoc 中添加 @category
标签,你只需要通过配置文件安装这个插件: