7

我目前正在开发一个 JavaScript 库。我把它组织成很多文件,我使用模块方法来定义每个“模块”。

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

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

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

因此,我打算为我的项目生成 JSdoc,希望如果我将它包含到 Eclipse(以某种方式)中,Eclipse 可以使用它来为我提供内容帮助。

首先,我不知道这是否可能......但是我认为这是我所看到的,这可能是的工作原理?但是,我试图遵循这一点并努力使某些东西起作用,我的意思是它不起作用。来自链接的有趣信息:

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

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

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

4

3 回答 3

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

取自Google Groups 线程。

更新答案:

Eclipse JavaScript 编辑器:js 文件的内容辅助,自动完成

于 2013-02-20T19:31:38.317 回答
1

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

我建议你安装 tern.java。它提供了JSDoc 支持。选择此支持后,您将受益

  • 完成:

JSDoc 完成

  • 很快就会得到验证:

JSDoc 验证

这种支持并不完美,但它开始发挥作用。

于 2015-06-16T08:10:10.263 回答
0

我不是自己使用它,所以我不确定它是否有效,但是 jsdoc3 存在一个 grunt-plugin。Eclipse 支持 Grunt。所以也许它有帮助。

npm 中的 Grunt 插件

于 2019-05-03T09:46:17.833 回答