生成jsdoc文档
我进行搜索以了解javascript文档生成器jsdoc的操作方式.使用它时，我的所有文档文件始终都位于index.js上，而文件，类或模块中却没有导航(位于文档网站中).此外，我还有一些未在文档中出现的标签.但是，我只使用usejsdoc网站( jsdoc的文档“)中给出的标签. 版本: Node.js:6.9.1 jsdoc:3.4.2 Server.js "use
..
jsdoc相关内容
JSDoc-将一些代码标记为不解析但保留文档?
我正尝试使用JSDoc(3)来记录Javascript文件，如下所示: /** 1 if gnome-bluetooth is available, 0 otherwise * @type {boolean}
..
如何为JSDoc生成HTML
我想为我正在构建的框架创建一个自动生成的JSDoc文档文件，但是似乎找不到一种输出文档的方法. 是否可以将文档输出为JSON或HTML?还是我必须使用RegExp构建自己的JSDoc解析器? 我在网上浏览了所有内容，却找不到任何内容. 谢谢. 解决方案 非常感谢Felix Kling向我指出了官方文档:文档已移至 https://jsdoc.app/
..
如何记录返回的事件发射器
如何用JSDoc记录MyFunc()中返回的stream发出的事件? /** * [MyFunc description] * @param {Object} opts - [description] * @return {Stream} - [description] */ function MyFunc (opts) { // stream is an EventEmitt
..
如何让@borrows标记在JSDoc中工作
我一直很难让@borrows标记在JSDoc中工作.我一直在尝试从一个功能获取文档，而将其作为第二个功能的文档.但是我似乎甚至无法获得一个简单的示例！ /** * This is the description for funcA */ var funcA = function() {}; /** * @borrows funcA as funcB */ var funcB = f
..
jsdoc @字符在代码块内
我正在尝试为类似Module的功能编写文档: /** * Usage: * * ``` * @NgModule({ * imports: [ * BrowserModule, * ..., * ThisModule.forRoot({ * name: 'Name', *
..
是否有任何用Java编写的开源JSDoc解析器?
我正在寻找可以在我的项目中使用的JSDoc解析器.我正在寻找可以传递JSDoc注释并获得对该注释含义的结构化描述的东西.我见过的大多数工具似乎都能将JSDoc注释转换为HTML或其他格式.我正在寻找一种可以提供注释的中间表示的东西，可以将其用于其他工具. 有没有我可以使用的工具或库? 解决方案 Doctrine项目完全可以满足我的需求: http://eslint.org/do
..
RegEx for jsDoc注释
找不到任何可用的RegExp示例来匹配文本文件中的所有jsDoc注释块. 基本上，它需要找到满足以下规则的所有块: 以/**开头，然后是一个或多个换行符 以*/ 结尾 在该块中可以包含任何内容，包括代码示例和HTML. 我尝试了 jsdoc-regex 中的代码，但是没有用: /[^\S\r\n]*\/(?:\*{2})([\W\w]+?)\*\/([\W\w]+?)?(?
..
寻求:如何在Webstorm IDE(v 4)中使用jsDoc的示例
我仍在学习js并尝试Webstorm IDE，这似乎很不错(包括跳转到var/function声明). 我可以看到如何获取jsdoc注释的模板，但我对此并不熟悉，并寻找一个示例来了解如何在注释中提供更多详细信息以及如何查看那个细节. 解决方案 WebStorm 4.0支持大多数此外，预计在第5版中将更好地支持Google闭包编译器标签.
..
如何记录可变数量的参数
如何记录可变数量的参数?我正在用PHP和JavaScript编写应用程序.目前，我(在JavaScript中): /** * Description * @param {String} description */ function fn() { // arguments holds all strings. } 那么，如何记录n个字符串参数? 解决方案 例如 PhpD
..
如何在JSDOC中记录对象数组
我有一个将对象数组作为参数的函数，并且想像本例中那样使用JSDOC描述参数(包括数组中对象的属性): /** * @param {Array.} filter - array of filter objects * @param ... */ function doSomething(filter) { } 其中过滤器是这样的: filter = [ {
..
如何为React PropTypes使用Typescript jsdoc注释
使用打字稿定义反应成分时，我们可以编写如下内容: class SomeComponent extends React.Component { // ... } 有没有一种方法可以使用 jsdoc注释并检查道具的类型. 解决方案 我更喜欢以下形式(es2015 + /** * @typedef {object} Pr
..
有没有一种方法可以在Visual Studio Code中生成JSDoc注释
我目前正在开发NodeJS项目，发现没有内置功能可以为函数/方法创建JSDoc注释. 我知道存在的TypeScript定义，但是我真的找不到符合我需要的东西. 例如， WebStorm具有一些非常简洁的JSDoc功能.能以某种方式实现类似的功能吗? 解决方案 Visual Studio 1.10现在可以生成JSDoc注释. 只需在函数上方输入/** 另请参见:
..
如何在Windows上使用JSDoc?
如果这是一个愚蠢的问题，请原谅我，但我对如何在Windows上使用JSDoc感到困惑.我知道JSDoc-Toolkit，但是它有点过时了，Google代码存储库建议改用JSDoc 3.我已经从Github下载了JSDoc，并将jsdoc-master文件夹解压缩到本地磁盘上，但是找不到有关如何使用它解析文件的任何可靠信息. 解决方案 您可以将其下载为npm软件包 Node.js JavaS
..
JSDoc:如何记录“选项"父“类"的对象字面量?
我正在使用jQuery的$.widget()基“类"，它提供了一个option()方法.由于该方法不在我的代码中，因此我没有地方记录该参数. 我尝试将jsDoc放在默认选项文字中的字段上，但是根本没有将它们拿起.然后，我尝试在同一对象文字上使用@class和@lends标记，但是由于对象文字不是真正的类，因此这可能会造成混淆. 我尝试过的另一种替代方法是将类似@param option
..
使用VS Code从HTML`< script>`中引用TypeScript定义文件
我可以在HTML的script标记中使用JSDoc，但不能引用类型定义文件(.d.ts).我正在使用VS Code.这可能吗，如果可以，我该怎么做?下面是一些示例代码: tsconfig.json文件(我不确定如何在测试中充分使用它，似乎不需要.): { "compilerOptions": { "baseUrl": ".", "paths":
..
是否可以在AppsScript的脚本编辑器中获得自动完成功能来处理自定义类?
如果我在AppScript中构造一个类并添加一个方法，当我在该类的实例之后键入句点时，是否可以使自动完成功能起作用? Google的文档表示“如果您希望您的图书馆用户使用脚本编辑器自动完成和自动生成的文档，您必须具有所有功能的JSDoc样式文档." 我不确定是否可行，或者我是否正确实施了JSDoc样式文档. /* * @constructor */ function MyCons
..
JSDoc中的文档重载函数
我有一个重载的 toggle 函数，想用JSDoc记录行为. 如果定义了该值，则将窗口状态设置为truey参数的布尔值，如果未定义，则将切换窗口状态.我正在寻找这样的东西. /** * Set the map window in mobile * @param {undefined|*} on - toggle or set the window state * - {unde
..
将流类型包括到JSDoc中
我一直在github和 他们都没有回答我有这个“简单"的需求: 问:如何将Flow类型包含在JSDoc中? 我不想摆脱JSDoc注释块，因为它们不仅用于类型检查，还用于文档编制以及向他人或您将来的自己解释代码. 这是我想要的: // @flow // This file should be parsed by flow // 1) Use all the advant
..
获取JSON格式的JSDoc输出
是否可以通过任何方式配置JSDoc，以使输出为JSON格式而不是通常的HMTL格式? 解决方案 有一个选项"-X"(“解释")，该选项使用已解析的AST创建JSON文件. jsdoc -X ./mylib/ > jsdoc-ast.json 要了解此JSON，您可以使用记录的架构:
..