javascript 文件中的@required 注释

Question

我正处于尝试为我们的 RIA 应用程序构建 JavaScript 库的起点。目前我们有很多 JavaScript 文件，其函数都在全局范围内，我想尝试为我们的函数添加一些合理的命名空间和上下文。可能将它们变成对象形式。

我一直在寻找其他开源库来帮助我了解构建库的最佳方式。我在一个特定的开源项目中看到了很多带有以下内容的 .js 文件。

/**
 * @required OpenLayers/Map.js
 */

例如。

除了作为文件中的注释之外，这是否还有其他意义？是否有某种方法可以使用此注释或 Java 中的导入语句将其他 .js 文件导入主构建？

Answer 1

这段代码很可能使用 JsDoc ( http://jsdoc.sourceforge.net/ ) 或类似的东西从源代码创建文档。

Javascript 实际上没有注释。

Answer 2

这是一个PHPDoc风格的注释，告诉任何使用该代码的人，如果没有它，它将无法正常工作OpenLayers/Map.js