JsDoc:如何仅记录对象
基础概念
JsDoc 是一种用于 JavaScript 代码的文档生成工具。它通过解析代码中的注释，生成 HTML 格式的文档，帮助开发者理解代码的结构和功能。
相关优势
- 自动生成文档：JsDoc 可以自动从代码注释中提取信息，生成结构化的文档。
- 易于维护：当代码更新时，只需更新相应的注释，文档会随之更新。
- 支持多种标记：JsDoc 支持多种标记，如
@param、@return、@type等，可以详细描述函数、变量和类的属性。
类型
JsDoc 主要有以下几种类型：
- 函数文档：描述函数的参数、返回值和功能。
- 变量文档：描述变量的类型和用途。
- 类文档：描述类的属性和方法。
- 模块文档：描述模块的功能和包含的类、函数等。
应用场景
JsDoc 适用于各种 JavaScript 项目，特别是大型项目和库。它可以帮助开发者快速理解代码结构，提高开发效率。
如何仅记录对象
如果你只想记录某个对象，可以使用 JsDoc 的 @type 标记来描述对象的类型。例如：
/**
* @typedef {Object} User
* @property {string} name - 用户名
* @property {number} age - 用户年龄
*/
/**
* 获取用户信息
* @param {User} user - 用户对象
* @returns {string} - 用户信息字符串
*/
function getUserInfo(user) {
return `用户名: ${user.name}, 年龄: ${user.age}`;
}在这个例子中，我们定义了一个 User 类型，并使用 @typedef 标记来描述它。然后在 getUserInfo 函数中，我们使用 @param 标记来指定参数类型为 User。
遇到的问题及解决方法
问题：JsDoc 生成的文档中包含了不需要的信息。
原因：可能是由于注释中包含了不必要的信息，或者 JsDoc 配置不当。
解决方法：
- 精简注释：确保注释中只包含必要的信息。
- 配置 JsDoc：可以通过配置文件或命令行参数来控制生成的文档内容。例如，可以使用
--private参数来包含私有成员的文档。
jsdoc -c jsdoc.conf.json --private在 jsdoc.conf.json 文件中，可以设置各种选项来控制文档生成的行为。
参考链接
通过以上方法，你可以有效地使用 JsDoc 来记录对象，并解决可能遇到的问题。
相关·内容
2回答
有函数的对象称为什么？
、、、
一个有函数的对象叫什么？我正在记录一些用jsdoc返回这一点的函数，而且我很难坚持用一种方式来传递它。
这就是我要回来的
{fnName: [function]}
或
{fnNameA: [function], fnNameB: [function]}
我在用这种方式记录返回值时遇到的问题是，不要期望属性为文字object.fnName和变量函数名。
如何在jsdocs中表示这一点？以上是标准吗？
作为程序员，我们如何称呼这种变量？
对象，其中值是函数。
具有函数的
具有函数属性的
对象的方法
具有命名函数属性的
有一个词能传达这一点吗？
浏览 0提问于2015-07-25得票数 0
回答已采纳
1回答
在JSDoc中，如何记录某个已定义类型的对象？ 例如，如果我有一个接收HTMLImageElement对象的函数，我应该如何在参数中记录它？ 是像这样的@param {HTMLImageElement} - An image还是@param {Object<HTMLImageElement>}？
浏览 17提问于2021-09-10得票数 0
回答已采纳
对于哪个JSDoc描述了类的构造函数，以及PHPStorm是否理解它们，我有点困惑。
当我研究使用哪种JSDoc时，我经常遇到两个版本。有@constructs和@constructor。
这两个标签意味着同一件事吗？
我应该在我的JSDoc中使用哪个标签？
使用PHPStorm是否对代码完整或智能感知有好处？
以下是一些参考资料。
现在我知道@constructs应该和@lends一起使用，但是为什么呢？
浏览 1提问于2013-07-28得票数 1
回答已采纳
1回答
在JSDoc中，如何记录接受多个对象类数组，如下所示：
var arr = [new Foo(), new Bar()];
如何编写类型，使Foo和Bar是数组中唯一接受的类？
浏览 2提问于2016-03-26得票数 6
*如何在JSDoc JSDoc中记录以下功能*
我想在这个主函数中记录下和帮助方法，但是我没有弄清楚如何做到这一点。
/** Sample doc
* @class
* @constructor
* @name Sample
*/
var main=function(){
this.value="";
/** help function
* @param {String} Name
*/
this.help=function(name){
console.log('help me'+name);
}
/** help f
浏览 3提问于2013-04-05得票数 2
请看下面的代码。所以我有一个对象，我想用jsdoc来记录它的属性，所以我使用jsdoc的来记录这个myObject对象的那些属性。但是，我也想记录更复杂的信息，比如一些代码示例，而不仅仅是简单的名称、类型和描述。
但是在中，他们说我们只能添加那些简单的名字或描述信息，而不能添加更复杂的东西(他们说：“它不允许你提供@示例或类似的复杂信息.”)。
/**
* An object with some simple properties
* @type {Object}
* @property {String} firstProperty This is the first property
浏览 6提问于2021-10-11得票数 2
回答已采纳
1回答
我使用JSDoc来记录我所写的所有JS，但是我很好奇人们是如何记录他们的更少的。我想我可以使用JSDoc，但这似乎不对，因为less不是JS。如果有一种允许不同IDE提供工具支持的标准方法，我还希望避免用JSDoc记录我的less。
有没有人知道一种记录更少的标准方法？
浏览 1提问于2014-11-22得票数 0
回答已采纳
我想使用jsdoc模块从一些源代码中提取文档条目。我已经安装了jsdoc模块，可以在命令行中使用jsdoc了。但是当我在代码中输入require("jsdoc")时，nodejs抛出了一个错误，显示为Cannot find module 'jsdoc'。
我有nodejs v0.8.25和JSDoc 3.3.0-alpha2。它既在本地安装，也在全局安装。我可以使用jsdoc命令，并且我的node_modules文件夹中有jsdoc。我看不出问题出在哪里。
除了如何在命令行界面中使用jsdoc或者如何记录js源代码之外，我还可以在哪里找到一些关于js的文档。我想
浏览 3提问于2013-11-28得票数 8
VS代码上的JSDoc是将道具显示为对象而不是数组。
您可以在这个中的函数名上悬停鼠标来测试它。
根据，它应该能够记录：
通过对象析构的道具值：@param {string} employee.name
数组项道具，如：@param {string} employees[].name
对于JSDoc对的支持，我也找不到任何限制。
这是VS代码、JSDoc的问题还是我记录JavaScript函数的方式的问题？
Note：我知道可以像下面这样使用@typedef来解决这个问题，但是我更感兴趣的是了解为什么文档不能像我预期的那样工作。
/**
* A standard u
浏览 0提问于2021-06-08得票数 5
1回答
有没有办法用JSDoc记录JS中的最后一个方法。
Java中的最后一个方法是不能被覆盖的方法。
我在JSDoc网站上找不到任何选择。
浏览 3提问于2021-09-01得票数 2
回答已采纳
1回答
我正在使用VSCode，如果您创建一个可以设置checkJS的jsconfig.json，那么您将开始得到语法错误和类型检查。很久以前，我构建了一个基于JSDoc的模式，它支持非常可靠的类型检查和转换。
现在我的问题是:代码正在运行，即使有错误，也没有构建过程。我希望有某种类型的链接，这给了我所有的类型错误，但理想的情况下，不应用其他一些约定在此之上，特别是当我无法配置它们(例如，我尝试了jslint，但首先我找不到如何在控制台上运行它的整个解决方案，我不能抑制某些警告)
我需要一个插件，一个链接，一些解决方案，立即搜索整个解决方案，并给出适当的错误。
请帮帮我，谢谢你抽出时间来！
PS:请不
浏览 20提问于2022-07-19得票数 -1
回答已采纳
1回答
我在使用JSDoc3记录这些代码时遇到了问题
/**
* @namespace MyNamespace.MySubNamespace
*/
(function (MyNamespace) {
MyNamespace.MySubNamespace.Foo = {
doSomething: function (someParam) {
// doing it
}
}
})(window.MyNamespace)
如何使用JSDoc3来记录MyNamespace包含包含Foo的MySubNamespace？此外，我如何将d
浏览 1提问于2013-06-15得票数 10
回答已采纳
2回答
如何记录以下代码片段？当我离开它的时候，Foo.bar没有描述。当我添加@memberof标记时，它将被记录为静态属性。添加@instance标记不会有任何改变。这是相当简单和常见的代码模式，所以应该很容易文档化，对吗？我讨厌jsdoc.
/**
* @namespace
*/
var ns;
(function (ns) {
'use strict';
/**
* Constructs class
* @class ns.Foo
*/
function Foo() {
}
/**
* B
浏览 0提问于2014-10-07得票数 1
回答已采纳
我有一些用CoffeeScript编写的代码，我想用谷歌闭包编译器优化生成的JavaScript，所以这些文件需要用JSDoc进行记录。
我的问题是，如何记录*.coffee文件，以便为闭包编译器生成包含工作JSDoc的javascript？
还有一个问题:有没有办法在*.coffee中保留单行注释？
浏览 1提问于2011-10-20得票数 46
回答已采纳
如果存在JSDoc类型，如何设置类型记录以使用它？
我有我的函数注释参数和返回类型，但是类型记录仍然和任何一样。如果存在JSDoc，如何设置类型记录以通过其JSDoc定义参数和返回类型？()
/**
* Creates arrow icon's class name to rotate it upon its x axis.
*
* Arrow icon communicates to the user that they can expand or collapse the filter.
*
* @param {boolean} isOpen If the filter
浏览 5提问于2022-07-10得票数 0
回答已采纳
2回答
如何记录混合或多重继承？
/**
* @class Parent
*/
function Parent() {
}
Parent.prototype.parentTest = 5;
/**
* @class Mixin
*/
function Mixin() {
}
Mixin.prototype.mixinTest = 5;
/**
* @class Child
* @augments Parent
* @mixin Mixin
*/
function Child() {
}
JsDoc有什么官方消息吗？如果不是，那么您希望它是如何编写的？
浏览 2提问于2011-01-30得票数 5
回答已采纳
如何在JSDoc3中正确地记录这些代码？
var Foo,
doFoo;
/**
* What JSDoc string should go here ...
*/
doFoo = function () {};
/**
* @constructor
*/
Foo = function () {};
/**
* ... and here ..
*/
Foo.doFoo = doFoo;
/**
* ... and here ..
*/
Foo.prototype.doBar = doFoo;
/**
* ... and here?
*/
Foo.proto
浏览 1提问于2013-09-12得票数 0
下面代码的JSDoc总是给出错误
错误: JSDoc描述不符合regex模式
在类型记录(使用)中生成Visual代码中的动态注释。
我们遵循JsDoc标准来注释和记录所有代码。
/**
* Validates if entityName is present in the Json Schema
* @param {any} obj Contains the object from the Json Schema
* @param {number} idx It contains the index of the object
* @
浏览 4提问于2020-08-11得票数 2
1回答
给定以下代码，如何使用最新的JSDoc正确地记录该文档？
function docMe([foo, bar = null, baz = 1]) {
/* */
}
我试过这样做：
/**
* @param {Array} options Array containing the options.
* @param {HTMLElement} options[0].foo An HTML element.
* @param {Object} [options[1].bar] An object.
* @param {Number} [options[2].baz] A numbe
浏览 2提问于2020-02-05得票数 8
3回答
背景
我正在记录我自己的JS库，我偶然发现了目录库( )。
它的文档有一个包含类别( Array、Collection等)的侧边栏，每个文档都有函数的文档。
目标
我希望我的文档使用最新的JSDoc版本具有类似的结构。
问题
经过调查后，我找不到由霍拉什使用的jsdoc模板。我也找不到类似的特性，也找不到如何使用JSDOC复制它。
问题
存放文档使用的是哪个JSDoc模板？
如果模板不相关，我如何在文档中包含类别？
浏览 3提问于2017-12-30得票数 4
回答已采纳
1回答
我正在尝试记录以下代码，但我似乎无法使JSDoc记录该类，甚至无法引用它的存在。
// SomeMixin.js
export default superclass => class SomeMixin extends superclass {
// class code goes here
func() {}
};
import SomeMixin from './SomeMixin';
import { EventEmitter } from 'events';
/**
* @param {SomeMixin} bar
*/
fun
浏览 0提问于2020-02-19得票数 7
1回答
我所处的旧项目太大，无法很容易地转换为类型记录，所以我一直在使用JSDoc。我无法理解如何在JSDoc中复制的类型记录功能是使用as const来完整地键入静态对象的属性名和值。
// In Typescript
const anObject = {hello: 'world'} as const;
// (type shows as {hello:'world'} instead of {hello:string}
在JSDoc中有与此类似的东西吗？我完全找不到这样做的东西(@readonly和@const不这样做)，所以我必须基本上复制粘贴任何静态对象作为类
浏览 3提问于2020-10-27得票数 20
回答已采纳
我想使用带有一些@example的JSDoc来记录javascript函数，但是它破坏了JSDoc。 我想要的代码示例如下所示(我想要的版本)： stripJSDoc(`/**
* Hello
*/
function Hello();
/**
* World
*/
function World();`)
// => ['Hello', 'World'] 我将在下面插入上面的内容。 /**
* Strip JSDoc text from given string.
*
* @example
*
* // I will insert abo
浏览 20提问于2019-04-11得票数 1
回答已采纳
7回答
我正在尝试记录一个Express中间件，但WebStorm中的内置验证工具告诉我，以下JSDoc块中的类型分配不正确：
/**
* My middleware.
*
* @param {Object} req
* @param {Object} res
* @param {Function} next
* @return {Object}
*/
exports.show = function(req, res, next) {
...
};
在Express sources中，我找不到任何@typedef来帮助我。另外，我想避免像@param {*}这样的东西。
使用JS
浏览 1提问于2014-12-03得票数 58
6回答
我有一些返回promise对象的代码，例如使用NodeJS的库。
var Q = require('q');
/**
* @returns ???
*/
function task(err) {
return err? Q.reject(new Error('Some error')) : Q.resolve('Some result');
}
如何使用JSDoc记录这样的返回值？
浏览 0提问于2012-10-28得票数 91
回答已采纳
1回答
我制作了一个组件，它用特定的AuthContext.Provider来呈现value。
它可以工作，但是当我在useContext组件的子组件中调用AuthProvider时，VS代码无法告诉useContext的返回类型。是否有一种方法(例如，使用jsdoc注释)来记录所使用的提供程序，因此VS代码将显示x的正确类型
我看到的：
我想看到的：
const x: {
login: (username: any, password: any) => Promise<void>;
logout: () => Promise<void
浏览 5提问于2022-11-14得票数 0
回答已采纳
我正在设置在我的余烬项目的埃林特。我希望强制使用jsDoc记录所有函数、类、操作和属性。
我面临的问题是，我似乎无法让强制执行来处理操作、组件声明或对象属性。
我最初尝试过“require”，但也注意到这条规则是不可取的。然后，我用以下配置安装了：
rules: [
...
'jsdoc/check-examples': 0,
'jsdoc/check-param-names': 1,
'jsdoc/check-tag-names': 1,
'jsdoc/check-types': 1,
'jsdo
浏览 0提问于2019-02-21得票数 1
我已经能够让JSDoc3与默认模板一起工作，但是，当我尝试运行另一个模板(甚至是它附带的那个)时，我得到了以下错误：
js: "/path/to/jsdoc/jsdoc.js", line 308: exception from uncaught JavaScript throw: Error: Unable to load template: Module "haruki/publish" not found.
我尝试了其他几个模板，也得到了同样的结果。关于我在JSDoc上的新生身份，我猜是配置或通话问题把我给绊倒了。
浏览 1提问于2013-07-18得票数 3
回答已采纳
当我以juaguarjs作为模板运行jsdoc时，我得到了错误ReferenceError: filename is not defined。
在以下情况下不会出现错误：-我运行jsdoc的默认模板-我运行jsdoc与jaguarjs模板，但没有教程配置。
项目的结构
|-- tut
| |-- tut1.md
| +--tut1.json
|-- jsdocconf.json
+-- Gruntfile.js
tut1.md
# Title 1
Text text text
tut1.json
{
"title": "Tutorial 1
浏览 1提问于2014-10-23得票数 0
我有一个带有jsdoc注释的函数，类似于代码中的以下内容：
/**
* Foo function
* @param {Object} [options]
* @param {String} [options.foo]
*/
var foo = function (options) {
if (!options) options = {};
var foo = options.foo || 'foo';
// ...
};
我的IDE，WebStorm，将options.foo标记为“未解决的变量”。如果删除jsdoc注释，则警告将消失。如何以We
浏览 4提问于2013-11-27得票数 4
1回答
我有一个以对象数组作为参数的函数，并希望使用JSDOC描述该参数(包括数组中对象的属性)，如下例所示：
/**
* @param {Array.<Object>} filter - array of filter objects
* @param ...
*/
function doSomething(filter) {
}
其中filter类似于：
filter = [
{id: 'session', value: 1},
{id: 'name', value: 'john'}
]
如何在jsdoc3中记录id和v
浏览 1提问于2015-08-30得票数 21
回答已采纳
在经历了几天令人沮丧的jsDoc实验之后，似乎对require js模块(AMD)的文档记录有它的问题。首先：
您不能将您的模块标记为class：
define([
"dcl/dcl",
], function (dcl) {
/**
* @class BaseClass
* See {@tutorial getting-started}
*/
var BaseClass = dcl(null,{
foo:function(a){}
});
return BaseClass;
});
jsD
浏览 0提问于2015-09-02得票数 2
1回答
我想使用JSDoc记录不能将对象作为值的对象。
允许的示例：
{
position: 'ground',
age: 0,
alive: false
}
不允许的例子：
{
data: [/* ... */]
people: {/* ... */}
}
有什么办法可以做到这一点吗？
例如，它可以在中完成。
浏览 0提问于2018-07-17得票数 2
回答已采纳
我写了很多代码，比如：
const MyFn = ({myInput}) => {
// code
};
我应该如何记录这些输入的类型？
如果我没有使用毁灭，我会写这样的东西：
/**
* @param {Number} myArg It's a number
*/
const MyFn = (myArg) => {
// code
};
...And我的IDE (VS代码)会把它捡起来并使用它来提供有用的建议。
({myInput})的非结构化语法的等效jsdoc是什么？
浏览 5提问于2020-12-16得票数 1
回答已采纳
2回答
我尝试这样记录一个枚举：
/**
* Enum for the different types of tokens
* @memberof Ecre
* @enum {number}
* @readonly
*/
Ecre.TokenTypes = Object.freeze({
/**
* A string token
*/
"string": 1,
"comment": 2,
"number": 3,
"boolean": 4,
"ident
浏览 1提问于2014-10-03得票数 3
1回答
有npm的角钢jsdoc
、、、
使用角-jsdoc，我使用这个命令生成我的文档。
**节点.\node_modules\jsdoc\jsdoc.js应用程序-c .\node_-c\角-jsdoc\公用\ docs .jsdoc -d docs -t -t
我不喜欢每次更新我的文档时输入这么长的命令。
我想知道一些快捷方式，以避免键入或复制/粘贴此命令。
浏览 1提问于2017-02-09得票数 0
回答已采纳
1回答
我编写了一些JSDOC的组件：
/**
* random jsdoc
*/
const Test = () => {
return;
}
现在，无论我在项目中使用这个组件(当然，使用JSDOC支持的编辑器)，我都可以看到这个JSDOC。
一旦这个Test组件连接到redux存储，这个JSDOC就会消失。我理解这是因为它创建了一个与实际组件不同的高阶组件。在概念上，它本质上是相同的组件&我们希望使用JSDOC来表达细节。在使用高阶组件之后，是否有一种传播JSDOC的方法？
浏览 3提问于2020-04-23得票数 0
我使用JSDoc来记录一个方法；正如您在下面看到的，我需要描述需要记录的参数to，该值为string或number 类型的只有，而接受的值仅为以下一个：
TYPE: VALUES ONLY ACCEPTED:
string - 'move:next'
string - 'move:prev'
number - any number
如何将此信息传递给JSDoc？
/**
* Description here
* @memberof app
* @method _moveTo
浏览 1提问于2016-03-05得票数 2
我使用的是jQuery的$.widget()基础“类”，它提供了一个option()方法。因为这个方法不在我的代码中，所以我没有地方记录这个参数。
我尝试将jsDoc放在默认选项文本中的字段上，但它们根本不被接受。然后，我尝试在同一个object文字上使用@class和@lends标记，但这可能会相当混乱，因为object文字并不是一个真正的类。
我尝试过的另一种方法是在构造器的jsDoc中放入类似@param options.field description的内容。但是，这样做的缺点是将文档与代码分开。此外，构造函数实际上没有名为options的参数，因为它都是由jQuery处理的。
你的
浏览 0提问于2012-05-21得票数 43
在声明扩展dojo/Stateful的模块时，getter和setter的模式是定义_xxxGetter和_xxxSetter，它们将表现为.get('xxx')和.set('xxx')。
所以，我的问题是，如何最好地用JSDoc来记录这一点？@function似乎不支持提供替代方法名称，而且无论如何，这是参数值的变体，而不是方法名称？
那么，JSDoc对这个模型有没有固有的支持，或者我只需要为这个东西编写显式的文档？
浏览 1提问于2012-08-19得票数 3
我目前用当前的jsdoc语法记录javascript函数和其他代码(im欢迎更改)。
function exportStuff(dataObject) {
/**
*
* @param {Object} dataObject - some details about it
* @param {function} dataObject.animationStart
* @param {function} dataObject.ajax - when invoked, returns a promise/.thenable, but I want to know
浏览 0提问于2020-04-01得票数 1
回答已采纳
我正在尝试使用jsdoc3来记录我的模块化主干应用程序。然而，当我尝试通过JavaScript运行这段代码时，我收到了错误消息，“来自未捕获jsdoc的异常抛出:错误:缺少依赖项: Backbone.model”：
/**
* A module representing a dog model
* @module dogModel
*/
define([
'underscore',
'backbone'
], function(_, Backbone) {
/**
* @constr
浏览 0提问于2012-07-24得票数 3
我正在记录我的React本机组件，但我不知道如何正确地完成它。
对于文档生成，我使用的是，据说它能够收集您在PropTypes上留下的注释，并将它们包含在文档中。但是..。由于不兼容问题，无法在Reactive原住民中执行此策略，因此，PropTypes 不包括在文档中。
如何使用JSDOC记录此React组件？
/**
* ??
*/
function Cat({ name, color = "#000" }) {
return <View />;
}
Cat.propTypes = {
name: PropTypes.string.isRequir
浏览 9提问于2022-02-22得票数 6
2回答
有下一个例子：
var CONF = {
locale: {
"en": {
name: "English",
lang: "en-US"
},
"es": {
name: "Spanish",
lang: "es-ES"
}
}
};
并且知道locale属性包含的是一个来自数据库的字典对象，我如何用JSDoc记录它的内部属
浏览 4提问于2013-10-22得票数 90
回答已采纳
我有一个javascript文件，其中包含许多注释的全局变量，但JSDoc一直告诉我“没有什么需要记录的，正在退出”。
下面是一个示例：
/**
* Name of the clients list
* @type String
* @final
*/
var CLIENTS_LIST_NAME = "Client";
有没有办法为这样的.js文件生成文档？
浏览 2提问于2009-06-24得票数 0
2回答
给定不允许修改的对象定义：
let a = {"a-b" : 5};
我如何在上面添加JSDoc？
我试过了
/**
* @type {{"a-b": number}}
*/
但是WebStorm告诉我，这是无效的JSDoc。
浏览 0提问于2018-03-19得票数 0
回答已采纳
我在使用JavaScript为我的JSDoc代码设置类型提示时遇到了问题(试图用VSCode和WebStorm来实现这一点)。
作为第一步，我使用GraphQL将JSDoc模式转换为一组JSDoc @typedef条目。为了这段对话，让我们谈谈这一次：
// schema.js
/**
* @typedef {Object} Country
* @property {string} code
* @property {string} name
*/
然后，在我的App.js中，我试着写：
// App.js
const GET_COUNTRIES = gql`
query Ge
浏览 8提问于2022-02-12得票数 3
回答已采纳
我有一个包，其中包含一些Javascript代码以及R代码。我可以使用pkgdown为包中的R文档构建一个由Github托管的网站，方法是正确设置并运行 pkgdown::deploy_to_branch() 我还可以使用JSDoc构建一个本地网站来记录Javascript代码，并将其放在pkgdown使用的docs目录中，其中包含来自其他部分的链接。这在本地工作，但当我使用上面的命令将其部署到Github时，JSDoc文件并不包括在内。 我如何告诉pkgdown在它部署到Github的网站中包含JSDoc文件？ 这个问题实际上与JSDoc无关；我可以认为它有一个子目录，其中包含我希望与pk
浏览 24提问于2021-05-05得票数 0
JSDoc在页脚中输出日期：
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0</a> on Fri Jan 17 2014 14:30:54 GMT-0800 (PST)
</footer>
因此，每当我重建我的库时，所有的文档文件看起来都变成了Git。这是不可取的--我只想在这些文档实际更改内容时提交它们。
我可以让JsDoc根本不输出这个脚注吗？
浏览 1提问于2014-01-17得票数 3
回答已采纳
我试图用jsdoc-工具箱记录特定模块模式中的函数，其中命名空间是在模块之外定义的。附加到它的函数在立即调用函数中。我从工具输出中得到的是：
警告:试图将isObject记录为无文档符号核心的成员。
下面是代码的简化版本：
/**
* @namespace The framework's top namespace
* */
var FX = {
/**
* @namespace The core framework functions
*/
core: {
}
};
(function( CORE, GLOBAL ) {
'use st
浏览 3提问于2012-06-29得票数 2
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
