我已尝试正确遵循 JSDoc guidelines对于我所有的代码,看起来我已经正确记录了我的构造函数,以便编辑器能够识别参数:
但出于某种原因,当我导出类以便其他地方需要它们时,它们在任何地方都不再被识别:
当用户需要我的库时,我是否遗漏了一些我应该导出类或记录导出的方式,这让编辑们感到困惑? require 语句本身是有效的,编辑器可以毫无问题地导航到 require 语句中引用的源文件 ('./YLTProfile'
),但由于某种原因,定义信息完全丢失。
这是另一个示例,说明它如何查看类定义,我可以按住 ctrl 并单击以导航到它(定义见右侧),但它以白色突出显示并且不提供有关该类的上下文或构造函数参数信息。
最佳答案
看来你必须让你的模块在node_modules中,然后它会自动出现在库中,或者手动添加一个库并指向包含你的模块的正确目录。
关于javascript - 如何正确记录 require module.exports 以便文档不丢失?,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/26763628/