如何使用JSDoc来记录JSON对象中的函数？
JSDoc是一种用于JavaScript代码的文档注释语言，可以帮助开发人员生成代码文档，并提供代码提示和类型检查。要记录JSON对象中的函数，可以按照以下步骤使用JSDoc注释：
- 在JSON对象中，找到包含函数的属性，并使用JSDoc注释格式注释函数。例如，假设我们有一个JSON对象
person，其中包含一个函数getName：
/**
* @type {object}
* @property {string} name - 人员姓名
* @property {function} getName - 获取人员姓名的函数
*/
const person = {
name: 'John Doe',
getName: function() {
return this.name;
}
};- 使用
@type注释指定JSON对象的类型为object，并使用@property注释指定JSON对象的属性。 - 在
@property注释中，使用{类型}指定属性的类型，例如{string}表示属性类型为字符串。 - 对于函数属性，使用
{function}指定其类型为函数。 - 在注释中，可以使用
@description提供有关属性或函数的详细说明。
使用JSDoc注释后，你可以使用支持JSDoc的编辑器或IDE（如Visual Studio Code）来获得代码提示和文档浏览功能。它们将根据JSDoc注释中指定的类型和描述提供相关信息。
关于腾讯云的相关产品和链接，我无法提供直接的答案，因为题目要求不能提及特定品牌商。但你可以在腾讯云的官方网站或文档中搜索相关产品，找到与云计算和开发相关的产品和文档。
相关·内容
下面代码的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
*如何在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
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
1回答
有没有办法用JSDoc记录JS中的最后一个方法。
Java中的最后一个方法是不能被覆盖的方法。
我在JSDoc网站上找不到任何选择。
浏览 3提问于2021-09-01得票数 2
回答已采纳
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
回答已采纳
如何在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
当我以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
1回答
我使用JSDoc来记录我所写的所有JS，但是我很好奇人们是如何记录他们的更少的。我想我可以使用JSDoc，但这似乎不对，因为less不是JS。如果有一种允许不同IDE提供工具支持的标准方法，我还希望避免用JSDoc记录我的less。
有没有人知道一种记录更少的标准方法？
浏览 1提问于2014-11-22得票数 0
回答已采纳
1回答
在JSDoc中，如何记录某个已定义类型的对象？ 例如，如果我有一个接收HTMLImageElement对象的函数，我应该如何在参数中记录它？ 是像这样的@param {HTMLImageElement} - An image还是@param {Object<HTMLImageElement>}？
浏览 17提问于2021-09-10得票数 0
回答已采纳
2回答
有函数的对象称为什么？
、、、
一个有函数的对象叫什么？我正在记录一些用jsdoc返回这一点的函数，而且我很难坚持用一种方式来传递它。
这就是我要回来的
{fnName: [function]}
或
{fnNameA: [function], fnNameB: [function]}
我在用这种方式记录返回值时遇到的问题是，不要期望属性为文字object.fnName和变量函数名。
如何在jsdocs中表示这一点？以上是标准吗？
作为程序员，我们如何称呼这种变量？
对象，其中值是函数。
具有函数的
具有函数属性的
对象的方法
具有命名函数属性的
有一个词能传达这一点吗？
浏览 0提问于2015-07-25得票数 0
回答已采纳
我写了很多代码，比如：
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
回答已采纳
请看下面的代码。所以我有一个对象，我想用jsdoc来记录它的属性，所以我使用jsdoc的来记录这个myObject对象的那些属性。但是，我也想记录更复杂的信息，比如一些代码示例，而不仅仅是简单的名称、类型和描述。
但是在中，他们说我们只能添加那些简单的名字或描述信息，而不能添加更复杂的东西(他们说：“它不允许你提供@示例或类似的复杂信息.”)。
/**
* An object with some simple properties
* @type {Object}
* @property {String} firstProperty This is the first property
浏览 6提问于2021-10-11得票数 2
回答已采纳
我希望在JSON对象中存储映射边界。为了实现代码完成，我使用JSDoc声明了对象：
/**
* @name MapBounds
* @class MapBounds
* This class represents a map boundary definition.
*
* @property {number} minLat Specifies the minimum latitude of the boundary.
* @property {number} minLon Specifies the minimum longitude of the boundary.
* @p
浏览 1提问于2013-01-26得票数 1
2回答
我正在使用和。我使用来使用自定义脚本从它生成HTML。
我有一个返回自定义类的函数(但我没有构造函数，也不需要构造函数)，我希望能够记录它(函数)和返回对象中的函数。
myLib.defer = function() {
return {
'then': function() {},
'resolve': function() {},
'reject': function() {},
'notify': function() {},
浏览 0提问于2012-11-27得票数 0
回答已采纳
3回答
如何记录匿名函数？
、、、、
我特别指的是JavaScript匿名函数，但这可能与其他语言相关。我喜欢在我的脚本中使用JSDoc符号，因为我知道其他人迟早会使用它。当我有相当复杂的匿名函数时，人们如何记录它，以便它被Eclipse和其他理解JSDoc或JavaDoc符号的集成开发环境所采用？
/**
* Blah Blah blah
*
* @param Object Blah blah blah
* @return Blah Blah Blah
* @type Object
*/
function foo(this) {
......
this.bar = function () { ... complex
浏览 0提问于2010-04-07得票数 3
回答已采纳
1回答
我正在寻找一种用JSDoc 3在Javascript中记录字典中包含的函数的方法。
即使我告诉JSDoc有一个带有@function的函数，它也没有包含在生成的文档中。
有没有能帮上忙的JSDoc标签？还是有比我的更方便的方法？
谢谢
/**
* @namespace Minitel
*/
var Minitel = Minitel || {}
/**
* @callback actionCallback
* @param {Stream} stream The Minitel Stream to which add the Videotex codes
* @param {O
浏览 21提问于2018-01-02得票数 1
回答已采纳
我有一些用CoffeeScript编写的代码，我想用谷歌闭包编译器优化生成的JavaScript，所以这些文件需要用JSDoc进行记录。
我的问题是，如何记录*.coffee文件，以便为闭包编译器生成包含工作JSDoc的javascript？
还有一个问题:有没有办法在*.coffee中保留单行注释？
浏览 1提问于2011-10-20得票数 46
回答已采纳
在我的VS2015 JavaScript应用程序中，我有一个JSON对象，它是从REST中获得的，我使用JSDoc @typedef注释记录了这个对象：
/**
* @typedef {Object} JSON_Response
* @property {Number} id
* @property {String} name
* @property {JSON_Response_Tag} tag
*/
/**
* @typedef {Object} JSON_Response_Tag
* @property {Number} id
* @property {String}
浏览 5提问于2016-01-18得票数 6
2回答
在jsdoc中记录这种样式的对象的正确方法是什么：
/**
*/
var strings =
{
/**
*/
stripHTML: function(html)
{
//does something
},
/**
*/
validHTML: function(html)
{
//does something else
}
}
即定义对象并将子功能识别为“字符串”的一部分的适当参数。我知道@param，@return等，我只是不知道这类对象的主要定义。
浏览 0提问于2009-06-13得票数 3
回答已采纳
1回答
在JSDoc中，如何记录接受多个对象类数组，如下所示：
var arr = [new Foo(), new Bar()];
如何编写类型，使Foo和Bar是数组中唯一接受的类？
浏览 2提问于2016-03-26得票数 6
我有一个带有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
VS代码上的JSDoc是将道具显示为对象而不是数组。
您可以在这个中的函数名上悬停鼠标来测试它。
根据，它应该能够记录：
通过对象析构的道具值：@param {string} employee.name
数组项道具，如：@param {string} employees[].name
对于JSDoc对的支持，我也找不到任何限制。
这是VS代码、JSDoc的问题还是我记录JavaScript函数的方式的问题？
Note：我知道可以像下面这样使用@typedef来解决这个问题，但是我更感兴趣的是了解为什么文档不能像我预期的那样工作。
/**
* A standard u
浏览 0提问于2021-06-08得票数 5
2回答
使用JSDoc，我如何记录这些代码？
var mynamespace = {};
/**
* What do I put here?
*/
mynamespace.myfunc = (function () {
var i = 0;
/**
* Do I need to put anything here?
*/
return function (a) {
return a + i++;
};
}());
在这种情况下，签名可以是：
/**
* @param {Number} base
* @return {Numb
浏览 1提问于2016-02-24得票数 4
回答已采纳
1回答
这是一个最初出现的问题，因为我试图用JSDoc记录一个JSDoc类，为了正确地记录类的构造函数，我需要知道返回值及其类型，我意识到我不知道。在研究它时，我找不到堆栈溢出的问题，所以我四处寻找ES2015类、新操作符和构造函数的详细信息。我已经找到了我认为可能是答案的东西，但我认为把问题和我的发现放在一起，看看其他人是否能证实或得到更好的答案，也许会有帮助。
为了演示这个问题，假设有以下代码：
class Rectangle {
constructor(height, width) {
this.height = height;
this.width = width;
}
浏览 0提问于2018-09-07得票数 1
回答已采纳
当数组元素可以是以下两种类型之一时，如何在JSDoc中记录Array返回值(和参数)：
对象文字A类型(如String，Array).An 。
浏览 132提问于2011-12-14得票数 32
回答已采纳
我正在设置在我的余烬项目的埃林特。我希望强制使用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
2回答
async function userInformation({ userId, token }) {
const body = {
user: userId
};
const headers = {
Authorization: `Bearer ${token}`,
'Content-Type': 'application/x-www-form-urlencoded'
};
const url = 'https://example.com/api/users';
const data = a
浏览 4提问于2019-10-16得票数 1
我想使用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
我知道这听起来像一个奇怪的问题，让我试着用例子进一步解释一下： 首先，我试图在一个简单的库中为JSDoc添加一些功能。我们称它为jsdoc-extra。 当一个项目包含我的库时，它还应该安装jsdoc。我也将jsdoc列为对我自己的库的依赖。 jsdoc-extra > package.json {
[...]
"dependencies": {
[...]
"jsdoc": "^3.6.6",
[...]
}
} 让我们假设一个“示例”项目正在尝试使用我的库(这是我现在实际运行的库，从文件中安装) {
浏览 28提问于2020-11-22得票数 0
1回答
我正在使用VSCode，如果您创建一个可以设置checkJS的jsconfig.json，那么您将开始得到语法错误和类型检查。很久以前，我构建了一个基于JSDoc的模式，它支持非常可靠的类型检查和转换。
现在我的问题是:代码正在运行，即使有错误，也没有构建过程。我希望有某种类型的链接，这给了我所有的类型错误，但理想的情况下，不应用其他一些约定在此之上，特别是当我无法配置它们(例如，我尝试了jslint，但首先我找不到如何在控制台上运行它的整个解决方案，我不能抑制某些警告)
我需要一个插件，一个链接，一些解决方案，立即搜索整个解决方案，并给出适当的错误。
请帮帮我，谢谢你抽出时间来！
PS:请不
浏览 20提问于2022-07-19得票数 -1
回答已采纳
5回答
JSDoc -如何记录原型方法
、、、、
我一直在尝试使用JSDoc来记录以下代码：
/**
* @module person
*/
/**
* A human being.
* @class
* @param {string} name
*/
function Person(name){
this.name = name
}
Person.prototype = new function(){
var amount_of_limbs = 4;
/**
* Introduce yourself
*/
this.greet = function(){
浏览 0提问于2014-12-07得票数 20
2回答
我可以将JSON对象从客户端发送到服务器，但不能从服务器上的JSON对象获得项。
我尝试了几个我在研究时发现的例子，我无法解决这个问题。
发送JSON的代码：
QJsonObject levan{
{"id",1},
{"tipo","reforço"},
{"ca", 10},
{"cb",0},
{"cc",0},
{"cd",0},
{"ce",0},
{"cf",0},
{
浏览 0提问于2019-03-29得票数 1
回答已采纳
1回答
因此，基本上，我想使用TypeScript来检查我的代码在编辑器中是否有错误(VS代码)，但不想执行任何转换步骤。
我在.js文件中有我的代码，"allowJs"：tsconfig.json中的真
唯一的问题是，编辑器会抱怨js文件中的类型记录词的使用，例如：
declare module "something" {
export interface MyInterface {
导致错误：
"'module' declarations can only be used in TypeScript files"
我试图不去
浏览 10提问于2021-11-08得票数 2
回答已采纳
1回答
我有一个来自我使用的OpenAPI服务的swagger.json规范(以swagger.json文件的形式)。我希望加快生成我的端点的开发过程，最好用JSDoc记录它们，以使事情在VS代码中顺利运行。
我发现了几个JSDoc到Swagger/ OpenAPI解析器和OpenAPI呈现器，例如：
但是，这些包以JSDoc作为输入，并呈现Swagger / OpenAPI规范作为输出。我想做的正好相反。谷歌对此没有多大帮助，我也没在StackOverflow上见过多少。
除了我自己的一揽子计划外，还有谁有建议？
浏览 3提问于2021-08-10得票数 0
回答已采纳
1回答
我试图在jsdoc 3.4.2中创建自定义标记。config.json文件是
{
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc","closure"]
},
"source": {
"include": [
"app/"
],
"exclude"
浏览 5提问于2016-10-26得票数 11
1回答
我有两个.js文件，表示一个模块。这个模块将表示与其他模块一起使用的API，因此我想很好地记录这个API的文档。
以下是文件和函数结构：
file1.js
// Include these functions
getCLO(); // Should appear in API doc view
addCLO(); // Should appear in API doc view
prepareCL(); // Should appear in internal module doc view not in API view
file2.
浏览 1提问于2016-02-07得票数 0
回答已采纳
1回答
我正在尝试使用JavaScript 3在AMD JSDoc模块中记录一个类。
/**
* A module representing a jacket.
* @module my/jacket
*/
define('my/jacket', function() {
/**
* @class
* @alias module:my/jacket
*/
function Jacket() {
}
/**
* Open and close your Jacket.
*/
Jacket.prototype.zip = functi
浏览 1提问于2016-09-09得票数 0
回答已采纳
在经历了几天令人沮丧的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
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回答
如何记录stream在MyFunc()中与JSDoc一起返回的事件？
/**
* [MyFunc description]
* @param {Object} opts - [description]
* @return {Stream} - [description]
*/
function MyFunc (opts) {
// stream is an EventEmitter
var stream = new MyEventEmitter();
stream.emit('event1', ... );
stream.emit('even
浏览 4提问于2016-01-07得票数 7
回答已采纳
我使用的是jQuery的$.widget()基础“类”，它提供了一个option()方法。因为这个方法不在我的代码中，所以我没有地方记录这个参数。
我尝试将jsDoc放在默认选项文本中的字段上，但它们根本不被接受。然后，我尝试在同一个object文字上使用@class和@lends标记，但这可能会相当混乱，因为object文字并不是一个真正的类。
我尝试过的另一种方法是在构造器的jsDoc中放入类似@param options.field description的内容。但是，这样做的缺点是将文档与代码分开。此外，构造函数实际上没有名为options的参数，因为它都是由jQuery处理的。
你的
浏览 0提问于2012-05-21得票数 43
就我个人而言，我不是生成文档的狂热爱好者(我更喜欢“阅读源代码Luke”的人)，但我知道这样的文档可能对其他人有用。现在，通常他们生成的文档不会影响我，除了一件事：@method。
大多数JSDoc注释(例如，对于阅读源代码的人来说，@method仍然非常有用，但它是100%冗余的：
/*
* @param num number to add five to
* @method addFive
*/
function addFive(num) { ...
所以，我真的希望避免让成百上千的@method行弄乱我们的代码。然而，我的同事认为@method是JSDoc生成器(他使用YUI on
浏览 2提问于2012-07-27得票数 13
回答已采纳
1回答
方法返回的未解析属性变量
、、、、
..。
doChunk().then(function (results) {
angular.forEach(results, function (info) {
if (info.data.fields.worklog) {
configProcess.results.push(info.data);
..。
以上只是我的AngularJS应用程序中的一个示例，但对于从其他地方返回的所有数据(和普通JS)来说，问题是相同的--比如本例中的HTTP请求。
结果-是HTTP请求的结果，包含一个对象数组。
因此，当我循环这个数组时，我访问这些对象的不同属性。一
浏览 1提问于2015-06-07得票数 3
回答已采纳
jsdoc没有解析<script>内容(带有有效JSDOC注释的有效JS )。
如何修复？
是否可以扫描脚本标记中的html文件和文档代码？
jsdoc: {
dist: {
src: ['assets/js/**/*.js', 'templates/users/*.html', 'README.md'],
options: {
destination: '.dev/jsdoc',
template: 'node_modules
浏览 10提问于2016-03-14得票数 2
回答已采纳
假设我有一个函数，它创建一个动态函数并返回它。
Function接受String类型的数据参数并返回String。
/**
* @param {String} data
* @returns {???}
*/
const foo = data => {
let functionString = 'return data;'
return Function('data', functionString)
}
我希望它以一个适当的定义出现在VSCode Intellisense中。如何在JSDoc中记录它？
浏览 7提问于2017-02-28得票数 0
回答已采纳
我正在记录一个NodeJS + Express项目，我希望能够从JavaScript文件中引用特定的更少的视图和Jade模板。例如：
/** Displays the homepage using the {@link views/index} view. Requires {@link stylesheets/news.less} for styling the news section. */
exports.index = function(req, res){
res.render( 'index', { title: 'Welcome' } )
浏览 11提问于2013-07-11得票数 1
回答已采纳
我已经安装了带有npm i -D jsdoc命令的jsdoc并创建了jsdoc.json文件。在package.json文件中，有一个名为doc的脚本，在执行npm run doc之后，jsdoc抛出一个错误Error: ENOENT: no such file or directory, open './readme/readme.md'
package.json
{
"name": "alphabetdb",
"version": "1.0.0",
"description": &#
浏览 5提问于2022-05-06得票数 0
2回答
使用JSDoc记录简单JavaScript对象(及其导出)的源代码的最佳方式是什么？
例如，我想记录以下对象：
/** how do I JSDocument object baseAdder? */
const baseAdder = {
/** how do I JSDocument property base? */
base: 1,
/**
* Add a number to base
* @param {number} a the number to be added to base
* @returns {number} th
浏览 7提问于2018-11-03得票数 3
1回答
在下面的代码中，company作为字符串的正确JSDdoc声明是什么？
fetch('https://api.github.com/users/mdo').then(res => res.json()).then(res => {
console.log(res.company);
});
我使用WebStorm，它可以理解地强调company是一个Unresolved variable
如果我添加
/** @namespace bogus.company **/
在文件中的任何位置，WebStorm都很高兴，但这没有任何意义：
这是
浏览 1提问于2017-06-12得票数 2
以一个最小的例子为例，这里是我所称的“提供者模式”函数(如果这里有其他名称，请更正我)。
export const callEndpointProvider = (endpointToCall: string) =>
async (accessToken: string): Promise<null> => {
return null
}
我想用JSDoc记录这个函数，这样就可以记录返回的函数，而不一定是提供者本身。
我在互联网上环顾四周，似乎找不到任何东西指向正确的方向，所以现在我已经足够记录提供商本身，就好像它是提供的功能一样。
这种方法的问题
浏览 6提问于2022-08-03得票数 1
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
实时音视频
对象存储
即时通信 IM活动推荐
腾讯云开发者
