如何为Closure Compiler的@typedef类型编写属性注释?
Closure编译器自定义类型属性添加行内注释的方法
在Closure编译器的自定义类型定义里,你可以直接在每个属性的类型声明后方,使用行内的/** ... */注释来添加属性说明,实现注释与属性同列的效果。
示例代码如下:
/** * @typedef {{ * foo:string /** 存储文本名称的字符串属性 */, * bar:number /** 存储统计数值的数字属性 */, * foobar: (number|string) /** 支持数字或字符串的混合类型属性 */ * }} */ var Mytype;
这种写法完全符合Closure编译器的注释规范,编译器能够正确识别并解析这些属性注释,同时也能保持代码结构的整洁性,让注释和对应属性一一对应。
内容的提问来源于stack exchange,提问作者Björn Morén
相关产品推荐
相关产品推荐

