如何正确记录需要module.exports以便文档不会丢失?

时间:2014-11-05 17:40:34

标签: javascript require webstorm browserify jsdoc

我已经尝试正确地跟踪JSDoc guidelines我的所有代码,看起来我已经正确记录了我的构造函数,以便编辑能够识别参数:

Documentation appears to work

但出于某种原因,当我将这些类导出为可以在其他地方使用时,它们不再被认可在任何地方:

No docs once exported

在用户需要我的图书馆时,我是否遗漏了导出课程或记录导致令人困惑的编辑器的方式? require语句本身正常工作,编辑人员可以轻松导航到require语句('./YLTProfile')中引用的源文件,但由于某种原因,定义信息完全丢失。


这是另一个例子,说明它如何看到类定义,我可以按住Ctrl键并单击以导航到它(右边的定义),但它突出显示为白色,并且不提供有关该类的上下文或构造函数参数信息。 / p>

enter image description here

1 个答案:

答案 0 :(得分:0)

您似乎必须在node_modules中安装模块,然后它会自动出现在库中,或者手动添加库并指向包含模块的正确目录。