假设我在 js 模块中有一个 typedef 类型

// somewhere/foo.js 
/** 
 * @module 
 */  
/** 
 * @typedef Foo 
 * @type {object} 
 * property {string} bar - some property 
 */ 

是否可以在另一个模块中引用此类型,以便在 jsdoc 生成的 HTML 页面中,该类型显示为指向 typedef-ed 模块的链接?

我尝试了这种变化,但似乎没有任何效果......
// somewhere_else/bar.js 
/** 
 * @module 
 */ 
/** 
 * @param {somewhere/foo/Foo} foo - some param 
 */ 
export default function doStuff(foo) { 
  ... 
} 

请您参考如下方法:

这对我有用...

// somewhere/foo.js 
/** 
 * @module foo 
 */ 
/** 
 * @typedef module:foo.Foo 
 * @type {object} 
 * @property {string} bar - some property 
 */ 

和 ...
// somewhere_else/bar.js 
/// <reference path="foo.js" /> 
/** 
 * @module bar 
 */ 
/** 
 * @param {module:foo.Foo} foo - some param 
 */ 
function doStuff(foo) { 
  //... 
}; 


评论关闭
IT干货网

微信公众号号:IT虾米 (左侧二维码扫一扫)欢迎添加!