如何在Eclipse中附加JSdoc,以便我可以为个人库自动完成

时间:2013-02-20 18:08:02

标签: javascript eclipse jsdoc

我目前正在处理一个JavaScript库。我已将其构建为大量文件,并使用模块方法来定义每个“模块”。

var ns = generateNamespace("me.mycompany.mypackage.MyFile");

(function (ns, undefined) {
    // some module 
}(ns));

模块是使用命名空间函数动态命名的,这意味着自动完成几乎是不可能的(除非Eclipse可以运行我的代码并找出命名空间,Visual Studio可以!)。

因此我打算为我的项目生成JSdoc,希望如果我将它包含在Eclipse中(不知何故)Eclipse可以使用它来为我提供内容帮助。

首先我不知道这是否可能......但我认为正如我所看到的那样this可能是如何工作的?然而,我试图遵循这一点,并努力让一些工作,我的意思是它不起作用。来自链接的有趣信息:

  

“JSDT库是具有原型对象/类定义和JSDoc的JavaScript源文件的集合。推理引擎然后对这些库进行建模......使它们可用于项目中的每个JavaScript文件......非标准和未来的绑定运行时同样易于创建...将...库添加到他们的项目并获得内容完成和悬停帮助“

我知道如何编写JSdoc注释,我知道如何使用各种工具之一生成JSdoc。

因此,我需要有关如何在Eclipse中包含JSdoc(可能是库)的说明,以便它可以自动完成JSdoc中的内容。

3 个答案:

答案 0 :(得分:1)

上一个回答:

You can also run jsdoc_toolkit from within eclipse by setting up Run -
> External Tools -> Open External Tools Dialog...

Location
C:\Program Files\Java\jre1.5.0_12\bin\java.exe

Working Directory
C:\DirectoryToWhereJsDocToolkitIsLocated\jsdoc_toolkit

Arguments
-jar app/js.jar app/run.js -r=4 -t=templates/htm "-d=C:
\PathToWhereDocIsSaved" "C:\PathToWebsiteToDocument"

For more about the arguments check the jsdoc_toolkit documentation.

Have fun
Simon

取自this Google网上论坛帖子。

更新的答案:

Eclipse JavaScript Editor: content assist for js files, autocompletion

答案 1 :(得分:1)

免责声明,我是tern.java的作者。

我建议你install tern.java。它提供JSDoc support。一旦选择了此支持,您就可以受益

  • 完成:

JSDoc completion

  • 并很快通过验证:

JSDoc validation

这种支持并不完美,但它开始有效。

答案 2 :(得分:0)

我不是一个人使用它,所以不确定它是否有效,但是存在一个针对jsdoc3的grunt插件。 Eclipse支持Grunt。所以也许有帮助。

Grunt-PlugIn in npm