问题标签 [jsdoc3]

我正在尝试使用 jsdoc( http://usejsdoc.org/ ) 生成 javascript 文档，但我运气不佳。我所有的评论都被忽略了。如何让我的所有评论在生成的 html 中可见？

在终端中，我运行以下命令：

我的 sample.js 文件如下所示：

我用于 jsdoc 的 conf.json 如下所示：

有没有办法配置 jsdoc 3.3.3 来容忍 ES6 模板字符串？也许有一个插件可以工作？

我有大量用于 node.js 项目的 json 模式。我可以以任何方式将它们用于：

• 从“.js”代码文件以 jsdoc 类型访问它们以提高 webstorm 智能感知的准确性
• 或者用于自动创建 jsdoc 类型定义

?

我试图生成一个 JavaScript 文件的源代码文档。为此，我还使用 markdown 语法编写了一个 README。我跑：

该命令生成 HTML 文档。在生成的输出中定义了以下标题：

我该如何更改Home并更改JSDoc: Home为有用的内容，例如我的程序名称？

我已经尝试按照此处的建议编写配置文件，但这似乎仅适用于教程而不适用于自述文件。

我正在寻找记录我的代码的最佳方式，但我什么也没找到。

我看过其他主题，包括this，但都没有解决我的问题。

我有这样的事情：

我需要生成一个清晰的文档，其中Product和Products类出现在模型/产品模块中，但我清楚地了解了模块和单独的类。

我想有人经历过这个问题。

谢谢。

PD1：我真的读过其他帖子，我不想重复问题。

PD2：对不起我的英语不好：S

如果我正在开发一个具有以下目录结构的节点模块something-nifty ：

而plugin.cs定义如下：

在生成的文档中，该类被记录为好像它具有@inner标记，这意味着每当我引用它时我需要重复两次类名：

当然，在这种情况下我不需要指定类名两次，因为模块本质上就是类。使用 jsdoc3 标签对其进行注释以输出结构正确的文档（模块和类列表）的正确方法是什么？

我认为JSDoc记录的所有成员/对象/等都应该是他们自己的可点击链接；例如，如果我有levelOne --> levelTwo --> levelThree --> levelFour，那么我应该在第一页上看到 levelOne 并且能够单击我的方式进入 levelFour...但似乎并非如此。

这是我的代码：

“命名空间”对象很容易点击，并且可以从主页访问，但PluginTests 不能点击（它不是链接！！），因此test1无法innertest1访问。我是否严重误解了 JSDoc 的工作原理？

PS：在有人开始用有害的评论撕毁我的代码之前，请注意我在大约 3 小时前了解到 JSDoc 的存在，并且对此非常陌生。

我正在考虑为我的 Angular 应用程序添加文档，到目前为止，从我的发现来看，JSDoc 似乎是一个受欢迎的选择。

我现在正努力在一个结构中生成一些文档，该结构遵循模块和其中定义的相关控制器\指令\服务\等。

首先，这是我正在处理的应用程序中的代码示例：

所以现在我想写一些文档来涵盖CustomersListController中定义的功能。

我已经看到这篇文章，其接受的答案展示了一种定义关系的方法，所以我尝试在我的代码中使用它，如下所示：

我正在使用gulp-documentation并设置了如下任务：

运行时会产生以下输出

我希望在左侧导航中显示正确的层次结构方面更具可读性，因此 app 在顶层，其次是 app.features 在第二级，app.customers 在第三级以目录样式显示。

另外，我注意到输出中也列出了“模块”，但我不确定它是如何生成的。我有模块声明，然后在我上面共享的代码中的一个模块上有一个控制器声明，那么 JSDoc 是从哪里获取的呢？

使用 JSDoc 语法定义 Angular 应用程序中声明的模块与其关联类（控制器、服务、指令等）之间的关系的正确方法是什么，以便它们出现在令人愉快的嵌套视图中，以便在生成的输出中轻松导航？

编辑

我也遇到过 ngdocs 和 gulp -ngdocs插件，但它似乎不是一个非常活跃的 repo，许多问题仍然存在。任何人都可以对这个插件及其适用性提供任何意见吗？我已经下载并运行了似乎运行良好的示例grunt-docs版本，尽管单击父“rfx”模块无法加载页面（在浏览器控制台中看到 404）——老实说让我有点紧张！

我刚刚开始掌握在我的角度应用程序中使用 grunt-ngdocs 并且到目前为止一切都很好。

但是我现在想在我的一个控制器中记录另一个记录的属性的一些属性。

考虑以下代码：

如您所见，我有一些挂在 vm 变量上的属性，这些属性通常是对控制器中定义的函数的引用。

使用上面的 ngdocs\jsdocs 文档语法，我可以将 vm 属性输出到我的文档文件夹中，但我不确定如何记录 vm 对象本身的属性。

有没有明智或推荐的方法来做到这一点？我确实想知道不完全记录 vm 而只是分别记录每个 vm.xxx，但我对此不太确定！

谢谢

我最近开始在我的 Angular 应用程序中使用 ngdocs，我对如何合理地记录模块配置和运行块感到困惑。

我目前有这个：

它按预期在文档中输出模块 app.core 。但是如何记录运行块？我正在努力寻找任何例子。

谢谢