问题标签 [jsdoc3]

目前在我的项目中我们正在使用 JSDoc，我们最近开始实施 Angular，我想继续使用 JSDoc 以确保所有文档都在同一个地方。

我看过人们主要只是说要使用 ngDoc，但这并不是一个真正可行的选择，因为我们将始终拥有单独的 JavaScript，理想情况下我会将所有东西放在一起。

目前这是我所拥有的，但无法为 run() 提供任何想法的文档？

我想输出其中包含 HTML 的示例，例如

但是目前它将它“安全地”呈现为 HTML 但是我希望它作为文本，目前我需要编写如下示例（这在实际的 JS 中更加乏味和丑陋）

有没有办法对 JSDoc 进行排序以防止 HTML 自动“安全”输出？

示例代码：

@returns记录方法时标签会是什么样子setSomeProperty？

@param是否可以像下面的示例一样对 JSDoc 类型声明使用枚举？

如果我对 JavaScript 使用 Eclipse 等 IDE，应该不会发出警告？

假设我有一些对象，使用 jsdoc3 评论它的方法是什么？

但是 jsdoc 仅为命名空间创建文档：测试和成员深度，默认值

命名空间：test test 测试对象

成员

深的东西

默认值 一些默认值

我正在寻找一种工具来生成 JavaScript 函数和属性的文档，即使没有与这些函数或属性相关联的适当格式的注释块（如 Doxygen 那样）。

JSDoc 与其他一些文档工具的比较提到，即使没有注释块（类似于 Doxygen，如上所述），JSDoc 也可以解析源代码以生成文档。他们说所有其他工具只解析评论块。

我根据此说明从 npm（在节点上）安装了 JSDoc 3.3.0-alpha4，并且我正在尝试为我的项目生成文档。据我所知，JSDoc 不会为没有带有相关 JSDoc 标志的正确注释的函数或属性生成任何文档。

我知道 JSDoc 经历了多次迭代，这个功能是否被删除或者我没有使用正确的开关？我试图检查命令行选项，但找不到任何开关。我只是像这样使用它：

我知道还有其他工具可以自动将文档块添加到代码中，例如smartcomments，但这并不是我想要的。任何人都可以对此有所了解吗？

我正在尝试记录类似于以下内容的内容，其中包含的属性是baz1和的成员bazzedbarbarFoo

现在 JSDoc 文档Fooand bar，但是它错过了baz1and bazzed。

我意识到我可以做这样的事情

但我不喜欢这样做，原因有以下三个：

1. 有些课程baz2:function(){}通过baz10:function(){}
2. 有些's 有很大的注释块，包含在's 的注释块baz中似乎没有意义。bar
3. 在某些地方，代码foo.bar.baz.buzz()仅包含原因 1 和 2。

我知道这是一个很长的问题，但我在过去的 4 个小时里一直在寻找空白。

我在我的项目中使用 jsdoc3，一切都编译得很好。

但这两天我一直在摆弄，我放弃了:(

当使用来自 MacOsX 终端的最基本调用来运行 jsdoc 时，我总是在生成的文档中获取源文件的完整路径。

例子：

在生成的索引文件中，我可以看到一个带有“索引”的 h1，下面是一个带有 js 文件完整路径的 h2：

我不喜欢它显示我完整的本地路径...
阅读后我认为它与我运行 jsdoc 的位置有关。
但这一切都具有相同的确切结果：

也

问题是，此路径也与行号引用和源代码页面一起使用。而且显示我的内部路径真的不太好...

我想要的输出是projectname/js/jsfile.js或至少只是jsfile.js，但我不能为我的生活得到这个工作。

我希望有人能告诉我我做错了什么。

问候，
扬

我目前正在尝试将现有的服务器端 JavaScript API 从现有的手动复制和粘贴继承系统迁移到更好、更可靠的系统。不能使用纯原型，因为对象的状态（变量）也必须被继承，并且不能在父对象中被覆盖。

所以我正在考虑使用这里描述的 John Reisig 的一个好的解决方案：http: //ejohn.org/blog/simple-javascript-inheritance/

哪个工人对我的情况很好。

我现在面临的唯一挑战是大多数文档框架不会处理这样构造的对象（或者我只是不知道如何告诉它们）。所以我的问题是，我如何记录这样的类：

我更喜欢 JsDoc，但我想不出用 JsDoc 记录这种类的方法。我还尝试了 NaturalDocs，它可以工作，但我真的不希望所有这些额外的 python 东西都在构建过程中。

我认为我遇到的主要问题是命名空间

例如：

不会在命名空间“命名空间”中包含或显示 ClassB

我正在尝试确定使用 JSDoc 3 将属性和选项参数记录到Backbone.Model.

理想情况下，我希望能够做到：

@option但是JSDoc 3中没有标签，并且@attribute与 Backbone 属性的含义不同。理论上，我认为可以以某种方式制作像我的伪代码中那样的自定义标签，但我找不到任何现有的插件，关于如何创建自定义标签的文档几乎不存在。

所以，既然我现在似乎坚持使用内置标签，我的问题是：我的伪代码（使用实际的 JSDoc 3 标签）的下一个最好的事情是什么？

注意：有几个与此类似的问题（如何 jsdoc 注释 BackboneJS 代码？，如何使用 JSDoc3 记录 AMD + Backbone 项目），但它们都集中在让 Backbone 对象得到识别的“大图”上。我找不到任何专门解决属性/选项问题的内容。