在javascript文件中@required注释

时间:2011-02-02 21:41:38

标签: javascript annotations

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

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

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

例如。

除了作为文件中的评论之外,这有什么意义吗? 是否有某种方法可以使用此注释或Java中的import语句将其他.js文件导入主构建中?

4 个答案:

答案 0 :(得分:4)

此代码使用JsDoc(http://jsdoc.sourceforge.net/)或类似的东西来创建源代码中的文档,很有可能。

Javascript实际上没有注释。

答案 1 :(得分:3)

选择RequireJS。它是一个JavaScript文件和模块加载器。它实现了CommonJS proposal

答案 2 :(得分:2)

这是一个PHPDoc风格的评论,告诉任何使用该代码的人,如果没有OpenLayers/Map.js

,它将无法正常工作

答案 3 :(得分:1)

JavaDoc,所有其他代码文档/注释系统的祖先(我认为)是派生的:

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html