jsdoc如何描述返回相同类变量的静态类方法
JSDoc是一种用于JavaScript代码文档化的标记语言。它允许开发人员通过注释来描述代码的功能、参数、返回值等信息，以便于团队成员阅读和理解代码。
对于描述返回相同类变量的静态类方法，可以使用JSDoc的@returns标记来说明返回值的类型和含义。具体描述如下：
/**
* 这是一个静态类方法的示例
* @param {number} num - 输入的数字
* @returns {MyClass} 返回一个MyClass类的实例
*/
static myStaticMethod(num) {
// 方法的实现
}在上述示例中，@param标记用于描述方法的参数，@returns标记用于描述方法的返回值。@returns标记后面的{MyClass}表示返回值的类型是MyClass类的实例。
关于JSDoc的更多用法和标记，请参考腾讯云开发者文档中的JSDoc文档。
腾讯云相关产品和产品介绍链接地址：
- 云函数（SCF）：无需服务器即可运行代码的事件驱动型计算服务。
- 云开发（TCB）：一站式后端云服务，提供云函数、数据库、存储等功能。
- API 网关（API Gateway）：用于构建、发布、维护、监控和安全保护面向应用程序的 API。
- 云数据库 MongoDB 版（TencentDB for MongoDB）：基于MongoDB的高性能、可扩展、可靠的数据库服务。
- 云服务器（CVM）：弹性计算服务，提供可扩展的虚拟服务器。
- 云存储（COS）：安全、稳定、低成本、高可扩展的云端存储服务。
- 人工智能开放平台（AI）：提供丰富的人工智能能力和服务，包括图像识别、语音识别、自然语言处理等。
- 物联网开发平台（IoT）：帮助用户快速构建物联网应用的开发平台。
- 区块链服务（BCS）：提供一站式区块链解决方案，包括区块链网络搭建、智能合约开发等。
- 腾讯云游戏引擎（GSE）：提供游戏开发和运营所需的一站式解决方案。
- 云原生应用引擎（TKE）：基于Kubernetes的容器化应用管理平台。
- 音视频处理（VOD）：提供音视频上传、转码、剪辑、播放等功能的云端服务。
- 云安全中心（SSC）：提供全面的云安全服务，包括安全态势感知、漏洞扫描等。
- 云网络（VPC）：提供安全可靠的私有网络服务，用于构建托管在腾讯云上的应用程序。
- 云监控（Cloud Monitor）：提供全面的云资源监控和告警服务。
- 云审计（Cloud Audit）：提供云上资源操作审计和合规性检查服务。
- 云解析（DNSPod）：提供高性能、高可靠的域名解析服务。
- 云市场（Marketplace）：提供丰富的云端应用和服务，满足不同业务需求。
请注意，以上仅为示例产品，实际应根据具体需求选择适合的腾讯云产品。
相关·内容
1回答
我使用JSDoc来记录我所写的所有JS，但是我很好奇人们是如何记录他们的更少的。我想我可以使用JSDoc，但这似乎不对，因为less不是JS。如果有一种允许不同IDE提供工具支持的标准方法，我还希望避免用JSDoc记录我的less。
有没有人知道一种记录更少的标准方法？
浏览 1提问于2014-11-22得票数 0
回答已采纳
我有一个TypeScript应用程序(4.0.x)，它包括以下软件包：
"@typescript-eslint/eslint-plugin": "^4.0.1",
"@typescript-eslint/parser": "^4.0.1",
"@vue/cli-plugin-eslint": "^4.5.4",
"eslint": "^7.8.1",
"eslint-plugin-jsdoc": "^30.3.1",
我的.eslint
浏览 4提问于2020-09-05得票数 1
回答已采纳
假设我有一个函数，它创建一个动态函数并返回它。
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
回答已采纳
我想为添加为JSDoc的属性添加Object.defineProperty文档。我想像这样的事情可能会奏效：
/** @constructor */
function MyClass() {
/** @property {Number} rnd */
Object.defin
浏览 3提问于2014-11-12得票数 2
回答已采纳
@Spence问了这个。
那么，这在Java中是如何工作的呢？在Java中，泛型类型在运行时被丢弃，那么用不同的泛型类型实例化的类的静态变量会发生什么呢？
浏览 1提问于2010-08-10得票数 5
回答已采纳
1回答
有没有办法用JSDoc记录JS中的最后一个方法。
Java中的最后一个方法是不能被覆盖的方法。
我在JSDoc网站上找不到任何选择。
浏览 3提问于2021-09-01得票数 2
回答已采纳
对于以下jsdoc @param对象，如何为name分配默认值
/**
@param inbound {{
email: string,
name: string,
req: Req
}}
*/
我试过了
/**
@param inbound {{
email: string,
name: [string=""],
req: Req
}}
*/
但这只是将其转化为一个数组[string, ""]。
与@typedef相比，我更喜欢这
浏览 0提问于2020-05-26得票数 1
回答已采纳
1回答
我有一个javascript方法，它接受一个迭代值，也就是说，任何跟在之后的对象。我想在它的JSDoc中对其进行注释。如何引用“iterable”类型？
/**
* @param {__WHAT_GOES_HERE__?} iterable
*/
function consume(iterable) { ... }
我可以用JSDoc写出整个协议，但这有点...难以置信的笨拙：
* @param {
* {
* Symbol.iterator: function(): {
* next: function() : {
* value: T|
浏览 0提问于2015-09-27得票数 3
根据的MSDN文档
应用程序代码不直接使用此类。此抽象类作为所有密码随机数生成器的基类提供。
对于加密随机数生成器的实现，请使用派生类RNGCryptoServiceProvider。
但是，我看到了在不同代码基中的几个八进制上使用的以下代码：
byte[] bytes = new byte[...];
RandomNumberGenerator rng = RandomNumberGenerator.Create();
rng.GetBytes(bytes);
最值得注意的是 (我认为它包括SO)和。
因此，我有点困惑--上面的代码返回的是哪种类型的RandomNumberGener
浏览 2提问于2012-09-08得票数 24
回答已采纳
我正在为一个项目使用eslint和google样式指南，但是它会为类组件抛出jsdoc错误，而不管jsdoc是否包含@return或权证。
以下将引发此错误：
...
112. /**
113. * DashboardBanner is the top bar of the body.
114. */
115. class DashboardBanner extends React.Component {
116. /**
117. * Caption for the constructor
118. * @param {type} caption here
119.
浏览 2提问于2021-06-30得票数 2
回答已采纳
1回答
我写了一些函数，比如：
/**
* Throw TypeError when val is invalid
* @param {JOIN_TYPES} type
* @param {Class|Function} cls
* @param {*} val
* @param {Object} options
* @param {String} options.wrongJoinTypeErrorMessage
* @param {Boolean} options.nullable
*/
function validateJoinSet(type, cls, val, option
浏览 3提问于2016-01-31得票数 3
我有一个问题:在java中，我们声明int、long、double等(原始数据)或非原语(对象数据)，不是用默认值初始化，而是在运行时使用默认值。现在我的问题是，哪一个分配默认值: java编译器还是Java虚拟机(JVM)？
例如：
int x;
System.out.println(x) //Result is 0;
浏览 1提问于2014-03-13得票数 5
回答已采纳
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
回答已采纳
我试图找到如何让JSDoc3从其他模块自动生成到类的链接。我觉得很难用语言来解释，所以让我举几个例子。下面的脚本生成预期的输出：
/**
* @constructor
*/
var SomeClass = function(){}
/**
* @param {SomeClass} someParam description
*/
var someFunc = function(someParam){}
也就是说，JSDoc3正确地生成从someFunc的参数列表到SomeClass的类描述的链接。但是，当我将SomeClass放入外部模块时，我似乎不能让JSDoc3生成链接：
/**
浏览 9提问于2012-10-16得票数 7
回答已采纳
我仍然在学习js并试用Webstorm，这似乎很好(包括跳到var/function声明)。
我可以看到如何获得jsdoc注释的模板，但我对它没有经验，我正在寻找一个示例，说明如何在注释中提供更多细节，以及如何查看的详细信息。
浏览 3提问于2012-06-18得票数 2
回答已采纳
在经历了几天令人沮丧的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
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
回答已采纳
JSDoc文档说明JSDoc仅用于生成API文档，但我们也使用谷歌闭包编译器进行高级编译
在一个函数作用域中，我们有许多字符串，例如
var cssLeft, cssTop, cssWidth, cssHeight, cssMinWidth, cssMinHeight, cssMaxWidth, cssMaxHeight, cssTransform;
有没有理由为这些变量中的每一个都包含@type {string}？
浏览 0提问于2015-07-07得票数 0
2回答
什么是字段？
、、、
在Oracle教程中，它是这样写的：
要访问字段，可以使用对对象的命名引用，如前面的示例所示，也可以使用任何返回对象引用的表达式。
既然'field‘是'class variable’的另一个名称，你为什么要使用‘对象的命名引用’呢？当然，使用“类的命名引用”会更好？
重写将如下所示：“要访问类变量，可以使用对对象的命名引用，就像前面的示例一样，也可以使用任何返回对象引用的表达式。”
“对象的命名引用”肯定会用来访问“对象变量”而不是“类变量”吗？
浏览 1提问于2015-12-08得票数 0
1回答
我试图用JSDoc来记录我的代码，但是我想不出如何使它能够识别类继承。下面是一个示例代码：
/**
* @classdesc Represents a Layer.
* @class
* @param {object} satellite - The satellite object.
* @param {string} date - The image date.
*
* @property {Satellite} satellite - The associated satellite.
*
*/
function Layer(satellite, date){
浏览 5提问于2022-11-18得票数 0
回答已采纳
在核心Java8的日期和时间库(即包java.time中的类)中，我发现了一个特殊的共同特点:这个包的每个类都没有公共构造函数，因此所有类都只能通过一些static方法(如of、now等)来实例化。在这个意义上，java.time中的类类似于工厂设计模式。但是，这些类确实不同于工厂设计模式，因为工厂设计模式的本质是松散耦合代码，用一个通用方法(通常是static)实例化各种类型的对象，因此返回的对象实例的类型直到运行时才确定。
然而，尤指。在java.time.LocalDate和java.time.ZonedDateTime类中，提到了关键字factory。您可以从以下位置找到关键字工厂：
浏览 3提问于2017-08-09得票数 6
回答已采纳
2回答
我正在学习单例设计pattern.the代码，如下所示：
public class Model {
private static final Model INSTANCE = new Model();
public static void main(String[] args) {
Model.getInstance();
}
private Model(){
System.out.println("constructor");
}
public static Model getInstan
浏览 2提问于2020-01-27得票数 0
回答已采纳
1回答
我有两个静态变量和两个函数的特性ExportOptions。
变量是$Code和$ExportType。$ExportType的内容在函数Set_ExportType中设置。两个变量在函数Convert_ExportCode中相遇。
函数Convert_ExportCode有以下简单代码：
private function Convert_ExportCode()
{
switch(static::$ExportType)
{
/*
* writes code
*/
case UniT::UNIT_OPTION_
浏览 5提问于2014-02-15得票数 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
如何在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
3回答
我使用PHP作为我的编程语言。我真的不明白静态方法和变量的使用。
什么时候方法应该是静态的?/什么方法应该是静态的？
如何确定什么方法应该是静态的？
利弊静态方法和变量？
谢谢
浏览 4提问于2012-09-23得票数 2
回答已采纳
2回答
为什么内部类不能有静态(非final)字段和方法？
这个问题之前已经发布过，但发布的答案是:这是一个设计决策，或者是因为内部类发生在外部类的上下文中，不能声明静态方法。
然而，这些答案并没有澄清我的问题。允许在内部类上使用静态字段和方法会有什么后果？我的猜测是，这两个限制是有联系的。由于静态方法需要访问内部类的其他静态方法和非final静态变量，甚至需要从外部类访问(为了能够更改内部状态)，这将导致内部类的行为类似于静态类。但是，JVM可以限制从内部类中的静态方法到内部类中的静态方法和数据的访问。然而，这提出了一个问题:为什么我们不能在内部类中声明静态的非final变量？
是这个设计还是有问题
浏览 0提问于2015-06-20得票数 4
5回答
我刚刚接受了一个采访，其中一个问题是“描述5种在Java中使用静态关键字的方法”。我只能当场想到两个，后来我又找到了两个。五号是几号？
声明属于类的字段，而不是类的实例。
声明可以在类上调用的方法，而不是实例。
将嵌套类声明为静态
定义静态类初始化程序。
?？?
浏览 2提问于2009-10-17得票数 8
回答已采纳
2回答
问:我正在编辑和使用一个开源的javascript库，它的代码中有JSDoc标签。我想知道是否有人知道可以让我从JSDoc标签生成类图的JSDoc插件。
编辑我决定尝试一下，并找到了以下内容。JS/ UML2tools扩展需要一个旧版本的eclipse (Indigo)和一个不受支持的依赖库UML2tools。我找到了所需的依赖项，并根据Eclipse软件管理器正确安装。当我尝试启用uml功能(配置了js根目录)时，该进程将挂起。该小组提供的示例指向单个文件Javascript。似乎在引用多个文件时遇到问题。
浏览 2提问于2013-12-19得票数 10
1回答
我有两节课，A和B
class A:
def name(self):
return B(name=self)
class B:
def __init__(self, name):
self.name = name
def hi(self):
return "Hi!" + self.name
def bye(self):
return "Bye!" + self.name
print(A.name('Robert').hi())
print
浏览 0提问于2021-11-28得票数 0
7回答
我有这个方法，我想在其中使用$this，但得到的结果是:致命错误:当不在对象上下文中时使用$this。
我怎么才能让它工作呢？
public static function userNameAvailibility()
{
$result = $this->getsomthin();
}
浏览 0提问于2010-02-18得票数 84
回答已采纳
我提取了DropdownSearch<String>小部件，并创建了一个独立的自定义小部件，扩展了DropdownSearch<String>的特性。我这样做是为了减少代码大小并封装某些功能。
平均而言，一个表单包含5-6个DropdownSearch小部件。它们是多种这类形式的。
我正在使用Dio包通过API调用填充小部件上的项。我使用built_value包创建了模型和序列化程序。
我的问题是如何通过const构造函数参数传递fromJson静态方法和模型类。
代码：
import 'package:dio/dio.dart';
import
浏览 7提问于2022-02-09得票数 0
假设你有这样的代码：
namespace StighyGames.CarsAttack {
public class CarsAttack
{
public static Channel[] ch = new Channel[30];
...
}
void main {
CarsAttack game = new CarsAttack();
}
}
在同一项目的另一个cs文件中，我声明了另一个类...
public class AnotherClass {
void AFunction() {
ch[1
浏览 0提问于2010-10-31得票数 0
回答已采纳
4回答
是否继承了静态变量？
、、、
我在1000多个地点读到静态变量不是遗传的。但是这段代码是如何工作的呢？
Parent.java
public class Parent {
static String str = "Parent";
}
Child.java
public class Child extends Parent {
public static void main(String [] args)
{
System.out.println(Child.str);
}
}
此代码打印“父”。
还可在
浏览 6提问于2016-05-14得票数 12
回答已采纳
2回答
由于某些原因，当我在这个类中调用命名空间时，我得到一个错误，指出它需要一个对象引用。我认为使用IMethodResponses类型的引用变量将允许我在自己创建的方法中访问它，但我无法实现这一点，也不能简单地在没有引用的情况下实现接口并使用它的方法……
有人能帮我解决这个问题吗？我也会发布接口本身，以防他们出了什么问题。我可能应该注意到，我做这件事的时间并不长。
//类实现接口：
internal sealed class Name : INameCreation, IMethodResponses
{
public ScratchCreate create = ScratchCreat
浏览 2提问于2011-05-21得票数 1
回答已采纳
2回答
我遇到了一种我无法理解的非常奇怪的行为。我有一个Texture类，它具有int类型的contentWidth属性。这个类包装在一个Image类中，该类具有类型为int的width属性。width的Image被简单地计算为底层纹理的contentWidth：
- (int) width
{
return texture.contentWidth;
}
现在，Image被希望读取图像大小的Button类(通过组合而不是继承)使用：
// image is of type ‘id’
int width = [image width];
int height = [image height];
浏览 4提问于2009-07-11得票数 4
回答已采纳
@interface TestObject:NSObject
+(instancetype)Object;
@end
@implementation TestObject
+(instancetype)Object{
TestObject *aObject = [[TestObject alloc]init];
return aObject;
}
以上代码运行良好！
但是，当我将代码更改为以下代码时，Xcode会抛出一个“EXC_BAD_ACCESS (code=1，address=0x0)”异常：
@interface TestObject:NSObject
+(id)Ob
浏览 0提问于2018-09-28得票数 2
回答已采纳
5回答
我是JAVA的新手，我喜欢尝试和理解所有的东西。
在JAVA中访问静态方法"hero.returnHp()“时，我有以下内容：
hero Mike = new hero();
Mike.returnHp();
该程序运行良好，但是我注意到Eclipse有一个警告，声明“来自类型英雄的静态方法应该以静态方式访问”。当我接受自动修复时，它将"Mike.returnHp();“更改为"hero.returnHp();”。
所以我有两个问题：
1)这样做的好处是什么？
2)如果我创建了两个相同类型的对象，当以静态方式访问时，我如何指定返回哪个对象？
谢谢!
浏览 3提问于2012-11-24得票数 8
回答已采纳
假设我有定义类的javascript代码。它的一个静态方法返回一个用于实例化子实例的类。
class ParentClass {
/**
* Creates an instance of parent class
*
* @param {string} type - the type of the instance.
*/
constructor(type) {
this.type = type;
}
/**
* Creates a child class.
*
* @param {string} type - the typ
浏览 3提问于2020-01-08得票数 1
回答已采纳
1回答
这是一个最初出现的问题，因为我试图用JSDoc记录一个JSDoc类，为了正确地记录类的构造函数，我需要知道返回值及其类型，我意识到我不知道。在研究它时，我找不到堆栈溢出的问题，所以我四处寻找ES2015类、新操作符和构造函数的详细信息。我已经找到了我认为可能是答案的东西，但我认为把问题和我的发现放在一起，看看其他人是否能证实或得到更好的答案，也许会有帮助。
为了演示这个问题，假设有以下代码：
class Rectangle {
constructor(height, width) {
this.height = height;
this.width = width;
}
浏览 0提问于2018-09-07得票数 1
回答已采纳
晚上好,
我正在开发一组Java类，以便容器类Box包含所包含的类Widget的List。Widget需要能够指定与其他Widgets的关系。我想一个很好的方法是这样做：
public abstract class Widget {
public static class WidgetID {
// implementation stolen from Google's GWT
private static int nextHashCode;
private final int index;
public Wid
浏览 0提问于2010-04-15得票数 2
回答已采纳
JSDoc 3的包括以下示例：
/**
* The complete Triforce, or one or more components of the Triforce.
* @typedef {Object} WishGranter~Triforce
* @property {boolean} hasCourage - Indicates whether the Courage component is present.
* @property {boolean} hasPower - Indicates whether the Power component is presen
浏览 3提问于2014-04-16得票数 6
3回答
当调用函数testFunc()时，我不使用语法Apples.testFunc()。然而，代码成功运行。怎么会这样呢？
class Apples {
public static void main(String args[] ) {
testFunc();
}
public static void testFunc() {
System.out.println("Hello world!");
}
}
浏览 3提问于2020-06-04得票数 5
回答已采纳
10回答
我有静态变量的概念，但是在类中使用静态方法有什么好处呢？我曾经在一些项目中工作过，但我没有创建静态的方法。每当我需要调用类的方法时，我都会创建该类的对象并调用所需的方法。
Q:方法中的静态变量即使在方法执行时也会保持它的值，但只能在其包含的方法中访问，但是静态方法的最佳定义是什么？
Q:调用静态方法而不创建类的对象是静态方法的唯一好处吗？
Q:静态方法的可访问范围是多少？
谢谢
浏览 47提问于2010-01-17得票数 66
回答已采纳
2回答
在学习的过程中，我为Android开发了一些小应用。作为一名PHP开发人员，适应它是一项挑战。
我特别想知道如何在一个单独的类中定义几个“通用”函数。例如，我有一个检查网络连接是否可用的功能，如果没有，会显示一个对话框，告诉用户应该启用它。目前，该函数存在于我的几个活动中。当然，这看起来很奇怪--我认为将其定义一次，并在需要的地方将其包含在activites中会更符合逻辑。
我试着把它放在一个新的类中，并将该类包含在原始活动中。但这失败了，因为getBaseContext()不再被接受。
我在想怎么继续下去。我谷歌搜索的目的是什么？这个机制叫什么？
浏览 0提问于2012-01-06得票数 0
回答已采纳
1回答
我有一个简单的ES6类，我想知道如何在JSDoc中正确地描述它。请注意，我希望定义自己的类型，这将在稍后被WebStorm自动完成识别。
下面的例子有效吗？
/**
* @typedef {Object} View
* @class
*/
class View{...}
浏览 6提问于2017-09-30得票数 7
回答已采纳
1回答
如果我有以下类型和函数
interface Mapper {
mapper: (number) => number
}
function withNumberAdded(num: number) {
return class implements Mapper {
mapper = (n: number) => num + n
}
}
withNumberAdded返回的确切类型是什么？原子告诉我它的typeof Anonymous class，但是如果我这样做
const IMPL = withNumberAdded(88)
console.log(new
浏览 2提问于2018-08-05得票数 0
回答已采纳
4回答
我正在尝试获取一个bash脚本，该脚本为给定参数生成JSDoc，如下所示
./jsdoc.sh file.js another.js maybe-a-third.js
我遇到了如何将未知数量的参数传递给下一个shell命令的问题。
(另外，不知道如何检查参数是否存在，只有在不退出if [ -z ... ]的情况下)
这段代码最多支持两个参数，但显然不是正确的方法……
#!/bin/bash
# would like to know how to do positive check
if [ -z "$1" ]
then echo no param
else
d
浏览 0提问于2011-08-06得票数 19
回答已采纳
就我个人而言，我不是生成文档的狂热爱好者(我更喜欢“阅读源代码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
回答已采纳
我正在设置在我的余烬项目的埃林特。我希望强制使用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
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
ICP备案
对象存储
腾讯会议
实时音视频活动推荐
腾讯云开发者
