2017-04-03 99 views
16

我可以在单独的文件中定义所有自定义类型(例如types.jsdoc),以便它们可以在整个应用程序中重用?什么是正确的做法?JSDoc typedef在单独的文件中

/** 
* 2d coordinates. 
* @typedef {Object} Coordinates 
* @property {Number} x - Coordinate x. 
* @property {Number} y - Coordinate y. 
*/ 
+0

是的,你可以。您可能需要在定义中添加'@ global',或者尝试JSDoc中命名空间的不同方法(混淆,恕我直言,为了我自己的目的,只有WebStorm inlineinfo/help和HTML API文档运行良好)。 –

回答

1

我通常在我的项目类似,区别在于我使用扩展.js来命名文件。 Webstorm完美工作,并能够检查类型和自动完成就好。它不会识别.jsdoc扩展名(我刚刚检查过),因此即使该文件不包含任何代码语句,也要坚持使用.js