javascript - 使用 Google Closure 的 @typedef 标签

Question

Google 的 Closure 编译器有一个“@typedef”标签，但是可以在您的代码中使用它们吗？ (我知道它会起作用，但它会让人不悦吗？)

这是我喜欢的类型

/** * The plan object's typedef * @typedef {Object} */Types.Plan = {    "style": "bordersmall",    "width": "50%",    "height": "40%",    "x": "20%",    "y": "10%",    "clickable": true,    "moveable": true};

然后我可以在我的 JSDoc 注释中使用该类型。

这让我的 IDE 可以自动完成传递的参数

所以声明的对象没有在代码中的任何地方使用。

/** * The Instructions class * @param   {Types.Plan}    plan        Plan for position and dimension * @param   {Manager}       manager     The manager * @param   {Instructions}  parent      This widget's parent's instructions * @return  {Instructions}              Returns the new instructions object */Instructions = function(plan, manager, parent){    plan.}

这样可以吗？或者有更好的解决方案吗？

Answer 1

这很好。您还可以使用记录类型来启用编译器的额外类型检查:

/**
 * @typedef {{
 *   style: string, 
 *   width: string, 
 *   height: string, 
 *   x: string, 
 *   y: string, 
 *   clickable: boolean, 
 *   moveable: boolean
 * }} 
 */
var myType = ...

http://code.google.com/closure/compiler/docs/js-for-compiler.html#types