带有轻量级标记的Javascript API文档框架
我正在寻找一个Javascript API文档框架，其功能类似于JSDoc，但会在代码注释中使用易于重构的文本或markdown（不是html） 奖金：将与Sphinx很好地融合。但是，我不想维护单独的文档，而是根据评论生成API文档。 http://code.google.com/p/jsdoc-toolkit/ 解决方案 我终于找到了最适合任务的JSDuck： htt
..
jsdoc相关内容
模板化对象的JSDoc对象
有没有办法可以松散地指定您要记录的对象中应该包含哪些类型的对象？ 我想要记录以下对象： var obj = { unknownName1：{ name：“KnownValue” } ， unknownName2：{ name：“KnownValue”， offset：{ x：0， y：0 } }， unknownName3：{ name：“KnownValue”，
..
JSDoc with和Immutable.js注释中的数据结构
我从函数返回Immutable.js 列表数据结构。 PHPStorm自动附加 @returns {* | List | List} 。 Eslint给我警告“T”类型的未解决变量。 我在哪里可以找到Immutable.js注释的文档？ 如何在列表的@returns中描述将在Eslint中传递的注释形状？ / ** * @param n *
..
如何用JSdoc引用另一个文件中的@class？
E.g。 MyClass.js / ** * @class * @name module：Bar * @param {number} a1 * @param {string} a2 * / 函数栏（a1，a2）{} 并且，在另一个文件中： / ** @type模块：Bar.constructor * / //组成语法 var Bar =
..
使用Closure-Compiler键入检查数组内容
在Google Closure中，如果特定 @type {Array。} 的数组是初始化后，我可以确定Google Closure是否会确认数组内容？ 这是一个小测试用例。在我看来， {Array。} 正在偷偷溜过 {Array。} 检查，但同一项检查正确阻止 {string} 。我对GC有点新手，这是我的错误吗？ 我已将其粘贴到 Go
..
如何在NetBeans中的JSDoc注释中转义@符号
我在API中有一个简单的方法，它允许使用JSONPath搜索对象。由于它的语法对于初级开发人员来说几乎是不熟悉的，所以我决定在JSDoc注释中提供一些示例。然而，这是捕获， - @ 符号被视为新jsdoc-tag的开头，因此描述已损坏。 问题：如何制作NetBeans （或一般的jsdoc）忽略 @ 特定代码块内的符号？最好在 @example 块内。 所以这段代码在工具提示中显示未经
..
使用JSDoc记录工厂
为了避免在我的JavaScript代码中使用 new ，我编写工厂来创建对象。 I我尝试了很多种组合，而且给我最满意的结果如下： / ** *文件模块 * @module app / document * / （function（）{ 'use strict'; / ** *创建文档对象的工厂。 * @alias模块：app / document.facto
..
jsdoc @typedef - 如何正确声明函数？
这是我的jsdoc声明。 我应该如何调整它，以便实际 MyNewType.logFirst 属性引用 logFirst 函数，我在下面注释了吗？ // my-new-type.js / ** * MyNewType定义 * @typedef {Object} MyNewType * @property {function} logFirst * @property
..
如何在jsdoc上添加和使用标签？
我正在尝试将customTag添加到jsdoc。我在插件目录中创建了一个文件，如下所示： method.js exports.defineTags = function（字典）{ dictionary.defineTag（“methodHttp”，{ mustHaveValue：true， canHaveType：false， canHaveName：true， onTag
..
将JsDoc3用于大型应用程序，如何将模块分组为sections / categories / submodules
我正在开发一款将会变得非常庞大的应用程序。我决定使用 JsDoc3 和 DocStrap 来记录所有模块。模块是通过require.js定义的，在某些地方它们最多嵌套3或4级。 直到现在我明白JsDoc文档分为四个主要部分：模块，类，教程，全局。每个部分都有一个标题下拉菜单和一个侧边栏，每个部分按字母顺序列出liniar方式的所有模块。 我想知道是否有显示/组的选项模块和类以某种方式反
..
在带有流类型注释的js上使用jsdoc
当尝试使用流类型注释处理js源时，jsdoc解析器很难理解增强的语法！有没有办法在使用流类型注释增强的js源中使用jsdoc，或者从类型带注释的js生成文档的推荐方法是什么？ 解决方案 您可以使用babel与 strip-流式转换并使用 jsdoc-babel 。 首先，您需要在jsdoc之上安装babel及相关软件包和jsdoc-babel。然后，在根目录中创建一个 jsdoc-c
..
是否有可能告诉jsdoc查看与源代码分开的文件以获取该代码的文档？
我希望尽可能缩短内联评论，因为我的经验是超过3或4行的评论往往被掩盖，创造了许多不必要的“阅读手册”。 遗产要求我遵守与jsdoc兼容的格式来记录代码。如果要正确记录，则需要明确声明许多不言而喻的事情。实际上每个标签都属于这一类。即使是那些不工作的人也常常对工作的开发人员毫无用处。 我的愿景是在开发人员实际阅读的代码本身内快速总结一下，但是参考到一个单独的文件（甚至是同一文件中的注释转
..
JsDoc：我如何记录对象可以具有arbritrary（未知）属性但具有特定类型？
这与问题30360391 类似。我想表达一个函数的参数是一个普通的JS对象，它可以具有任意属性（具有未知的）名称，但所有属性都是具有固定属性的对象本身。 一个例子：函数就像这样 / ** * @param {Descriptor} desc * / 函数foo（desc）{ // ... ... } 和典型的 desc 看起来像 desc =
..
JSDoc：模块和命名空间之间的关系是什么
我在理解联合中命名空间和模块的目的时遇到了问题。例如，我有一个类 Game.utils.Matrix 。我想注释游戏作为命名空间， utils 作为模块和矩阵作为一个班级： / ** * @namespace游戏 * / / ** * @module utils * @memberOf游戏 * / / ** *创建一个矩阵 * @constructor
..
如何使用JSDoc记录ECMA6类？
背景 我在Nodejs中有一个使用ECMA6类的项目，我正在使用 JSDoc 评论我的代码，以使其他开发人员更容易访问它。 但是，我的评论并没有得到工具的认可，我的文档也是火车残骸。 问题 我的问题是我不知道如何使用JSDoc记录ECMA6类，我可以找不到任何体面的信息。 我尝试了什么 我试过读官方示例但我发现它缺乏且不完整。我的类有成员，常量变量等等，我通常不
..
使用Google Closure的@typedef标签
Google的Closure编译器有一个“@typedef”标记，但在代码中使用它们是否可以？ （我知道它会起作用，但是它不受欢迎吗？） 所以这是我的类型 / ** *计划对象的typedef * @typedef {Object} * / Types.Plan = { “style” ：“bordersmall”， “width”：“50％”， “height”：
..
局部变量的正确JSDoc语法是什么？
对于这样的函数... function example（）{ var X = 100; ... var Y ='abc'; ... 返回Z; } 我需要解释一些局部变量的用途。添加这样的描述... function example（）{ / ** * @ description - 需要在这里解释X的目的。 * /
..
使用JSDoc记录成员函数
我有这样的事情： / ** Diese Klasse bla bla ... @constructor ** / my.namespace.ClassA = function（type） { / ** 此函数执行 ** / this.doSomething = function（param）{ } } 该类将在生成的文档中列出。该功能不会。有
..
如何“导入”使用Node.js在JSDoc中从一个文件到另一个文件的typedef？
假设我有一个名为“File1.js”的文件。在这个文件中，我导出了一个对象对象，我给每个对象一个typedef，就像这样。 / ** *我的每个对象的typedef。 * @typedef {Object} MyObject1 * @property {String} username您的用户名 * @property {String} realname您的真实姓名。 *
..
JSDoc和JavaScript单例文档
我将JavaScript单例定义为： / ** *此处的描述 * @class * / com.mydomain.ClassName =（function（）{ / ** * @constructor * @lends com .mydomain.ClassName * / var ClassName = function（）{}; / **
..