如何让JSDoc无需声明新对象或函数也能生成对应文档?
JSDoc 强制识别无声明对应注释的解决方案
JSDoc默认只会收录绑定了变量、函数、类等声明语句的注释,对于调用语句对应的游离注释,可以通过手动指定注释对应的实体属性来强制收录,具体可使用以下两种方案:
- 使用
@name标签强制创建独立文档条目
这是适用范围最广的方案,@name标签会直接告诉JSDoc为该注释创建一个指定名称的独立文档,搭配类型标签(如@function/@constant等)就能正常生成文档,你的示例代码可以修改为:/** * 自定义JSONLogic平方根运算 * @name JSONLogic.sqrt * @function * @param {number} input 待计算的数值 * @returns {number} 平方根计算结果 * @description 给JSONLogic注册名为sqrt的自定义运算,底层实现直接复用原生Math.sqrt方法 */ JSONLogic.add_operation('sqrt', Math.sqrt); - 使用
@memberOf标签绑定到已有对象
如果注释的内容属于某个已有对象的新增成员,可以用@memberOf标签明确所属对象,JSDoc会把该注释的内容归类到对应对象的成员列表中,无需额外创建独立条目。
你之前尝试添加@todo标签不生效的原因是,@todo属于附加属性标签,仅当JSDoc已经判定该注释对应一个可收录的文档实体时才会生效,单独的附加标签无法触发JSDoc收录游离注释。
内容的提问来源于stack exchange,提问作者Michael Sperling
相关产品推荐
相关产品推荐

