问题标签 [jsdoc]

我一直在尝试使用 JsDoc 来记录我的 javascript，但我一直遇到这个障碍。它一直说“没有什么可记录的，退出”

这是我要记录的代码片段：

上面我正在使用命名空间。即使我在 JavaScript 中使用函数定义的变体形式，JSDoc 似乎也无法识别它。例如：

知道如何解决这个问题吗？谢谢！

假设我有这样的课程：

有没有办法向 JSDoc 表明 someFunction 不仅仅是一个应该直接调用的函数，而是一个事件处理程序？

我看到了@event 标签，但如果我理解正确，这更多的是记录我认为是事件的类中的函数（客户端代码也会注册，并且我的类会在需要时触发）而不是事件处理程序功能 ？

我特别指的是 JavaScript 匿名函数，但这可能与其他语言有关。我喜欢在我的脚本中使用 JSDoc 符号，因为我知道其他人迟早会破解它。当我有相当复杂的匿名函数时，人们如何记录它以便它被 Eclipse 和其他理解 JSDoc 或 JavaDoc 符号的 IDE 拾取？

谢谢

我有以下 Moo 课程：

我想用 JsDoc 记录它。我读到你可以@lends [class].prototype在里面使用new Class并initialize用@constructs标签标记。如何标记方法和事件？

IE：setHtmlContents应该是一个方法，close应该是一个事件。

此外，是否可以options以某种方式记录下的元素？

<code />你知道JSDoc中是否有某种标签吗？我需要在我的文档中添加如下代码：

我需要 JSDoc 将注释中的代码显示为代码（如果没有突出显示语法，至少像预先格式化或带有灰色背景的东西）。

你知道在@param 和@return 块之后是否可以写一些东西。假设我想在参数/返回声明之后写一段文本，与它们分开。

似乎 Javadoc 和 Jsdoc 都将您在 @param/@return 之后编写的任何内容附加到同一块 conetnts 中。

例如，假设我希望文档显示如下：

编辑：这在技术上是一个两部分的问题。我选择了涵盖一般问题的最佳答案，并链接到处理特定问题的答案。

用 jsdoc 记录匿名对象和函数的最佳方法是什么？

代码中既不存在PageRequest对象也不callback存在。它们将getPage()在运行时提供给。但我希望能够定义对象和函数是什么。

我可以摆脱创建PageRequest对象来记录：

这很好（尽管我愿意接受更好的方法来做到这一点）。

记录函数的最佳方法是什么callback？我想在文档中说明，比如回调函数的形式是：

任何想法如何做到这一点？

我正在为我的源代码使用 PHPDoc 和 JSDoc。我知道有一些工具可以从这些文档中构建 API。但是，我想知道的是，应该如何解释复杂的代码？我是否只是在函数中使用多行注释而不是在 PHPDoc/JSDoc 中进行解释？

例如，考虑以下代码：

在上述情况下，我应该如何去注释复杂的代码？我认为我不能在 JSDoc 中做到这一点，因为它用于构建 API（这是关于“如何使用”而不是“事情如何工作”），对吧？

我的假设是否正确：

• JSDoc/PHPDoc 是专门为那些将要使用函数/方法的人编写的。
• 函数中的注释是为需要了解函数/方法背后逻辑的任何人编写的。
• 文档与 API 和源代码注释是分开的，文档（每个软件都应该提供）是为那些想要使用该软件的人编写的。

但我不明白的是，在架构层面解释软件的内容——是否也应该有开发人员文档？

您完善文档的策略是什么？

如何记录可变数量的参数？我正在用 PHP 和 JavaScript 编写应用程序。目前我有（在 JavaScript 中）：

那么，我如何记录 n 个字符串参数？

我正在记录一个包含 Python 组件和 JavaScript 组件的库。整个用户文档和 Python API 文档都在 reStructuredText 中，使用 Sphinx 处理。JavaScript API 位于 jsdoc 中，并使用 jsdoc-toolkit 进行处理。主要输出格式为 HTML。我是 reST、Sphinx 和 jsdoc 的新手。

我已经建立了一个构建系统，所以所有生成的 html 页面都被转储到一个目录树中。我现在需要在主页（从 reST 生成）中插入指向生成的 Javascript 文档的链接。这需要是一个相对链接，因为文档可能位于不同安装的不同位置。reST 会自动解析一个完整的 URL，但我不知道如何让它插入一个相对链接。:ref:和:doc:之类的构造似乎没有帮助，因为它们希望目标是 reST。

有任何想法吗？