在JavaScript

时间:2017-07-31 17:31:11

标签: javascript

我见过Google在各种API中使用了很多Type Expressions。有人可以向我解释他们有什么好处吗?它们是否仅用于突出显示/对某些功能进行颜色编码,或者是否易于阅读?或者他们是否有实际目的?

我有点困惑,因为它们与已注释掉的代码一起使用但与使用/** @type */而不是/* @type */的常规评论不同(不对其进行颜色编码)评语)

有人可以告诉我类型表达的方式和原因吗?

enter image description here

1 个答案:

答案 0 :(得分:2)

您会在Google以外的很多地方看到这些内容。它们可用于Closure Compiler以改进优化,并在出现类型错误时通过警告提供一些类型安全性。

但更常见的是这些JSDoc标签,它们允许您注释和描述javascript代码。标签可以记录您编码的数据类型以及将返回的内容。然后,可以使用它自动生成有关代码的文档,文本编辑器和IDE也可以使用它们在工作时提供反馈。许多流行的编辑都支持这一点,如Sublime Text和Visual Studio。

此处有大量信息:http://usejsdoc.org/index.html