JSDoc - 在分离文件中创建自定义类型的正确方法

时间:2015-07-27 12:25:01

标签: javascript angularjs intellij-idea jsdoc jsdoc3

我想创建自定义类型,例如代码完成,在custom-types.js的分隔文件中,我在Rzslider angular repository中找到的方式,位于文件Rzslider.js file的底部:< / p>

/**
 *
 * @name Author
 * @property {number} id
 * @property {string} name
 * @property {string} surname
 */

这是记录自己类型的正确方法吗?它应该在分离的文件中,使用JSDoc注释尽可能少地污染代码,这一点非常重要。我正在使用带有插件的JSDoc 3到Intellij 14,请提前感谢您帮助我。

1 个答案:

答案 0 :(得分:0)

关于使用jsdoc记录角度代码,我回答了类似的问题。请参考here