如何在JSDoc中记录javascript IIFE模块
在JSDoc中记录JavaScript IIFE（Immediately Invoked Function Expression）模块，可以使用以下方式：
/**
- @module moduleName
- @description A brief description of the module. */
/**
- @function
- @name functionName
- @memberof moduleName
- @description A brief description of the function.
- @param {type} parameterName - Description of the parameter.
- @returns {type} - Description of the return value. */
/**
- @namespace
- @name namespaceName
- @memberof moduleName
- @description A brief description of the namespace. */
/**
- @typedef {Object} typeName
- @memberof moduleName
- @property {type} propertyName - Description of the property. */
/**
- @class
- @name className
- @memberof moduleName
- @classdesc A brief description of the class.
- @extends superClass
- @implements interfaceName */
/**
- @member {type} memberName
- @memberof moduleName
- @description A brief description of the member. */
在上述示例中，"moduleName" 是模块的名称，可以根据实际情况进行命名。"functionName" 是IIFE模块中的函数名称，"namespaceName" 是IIFE模块中的命名空间名称，"typeName" 是IIFE模块中定义的自定义类型名称，"className" 是IIFE模块中定义的类名称，"memberName" 是IIFE模块中定义的成员名称。
在每个注释块中，可以提供对模块、函数、命名空间、自定义类型、类和成员的详细描述。可以使用@description标签提供详细描述，使用@param标签和@returns标签指定参数和返回值的类型和描述。
对于IIFE模块中的每个函数、命名空间、自定义类型、类和成员，都可以使用@memberof标签指定其所属的模块名称。
注意：以上示例中的"moduleName"、"functionName"、"namespaceName"、"typeName"、"className"、"memberName"、"type"、"parameterName"等都是占位符，需要根据实际情况进行替换。
以下是一个示例：
/**
- @module MathUtils
- @description A utility module for mathematical operations. */
/**
- @function
- @name add
- @memberof MathUtils
- @description Adds two numbers.
- @param {number} a - The first number.
- @param {number} b - The second number.
- @returns {number} - The sum of the two numbers. */
/**
- @namespace
- @name Geometry
- @memberof MathUtils
- @description A namespace for geometric operations. */
/**
- @typedef {Object} Point
- @memberof MathUtils
- @property {number} x - The x-coordinate of the point.
- @property {number} y - The y-coordinate of the point. */
/**
- @class
- @name Circle
- @memberof MathUtils.Geometry
- @classdesc Represents a circle.
- @param {Point} center - The center of the circle.
- @param {number} radius - The radius of the circle. */
/**
- @member {number} Circle#radius
- @memberof MathUtils.Geometry.Circle
- @description The radius of the circle. */
在这个示例中，"MathUtils" 是模块的名称，包含了"add"函数、"Geometry"命名空间、"Point"自定义类型和"Circle"类。每个注释块都提供了相应的描述和详细信息。
对于"add"函数，它属于"MathUtils"模块，接受两个参数并返回它们的和。
对于"Geometry"命名空间，它属于"MathUtils"模块，用于组织几何操作相关的功能。
对于"Point"自定义类型，它属于"MathUtils"模块，具有"x"和"y"属性，表示一个点的坐标。
对于"Circle"类，它属于"MathUtils.Geometry"命名空间，表示一个圆，具有"radius"属性表示半径。
以上示例中的描述和详细信息仅供参考，实际使用时需要根据具体情况进行调整和补充。
腾讯云相关产品和产品介绍链接地址请参考腾讯云官方文档。
相关·内容
1回答
使用AngularJS创建JsDoc3文档的问题
javascript、angularjs、documentation、jsdoc、jsdoc3
我有一个AngularJS工厂，我正试图生成使用Jsdoc的文档。逻辑如下：
(function (angular) {
/**
* @module factories
* @memberOf angular_module
*/
var factories = angular.module('factories');
/**
* @class BaseService
* @classdesc Base object
* @param {Object} $rootScope Root scope for
浏览 3提问于2015-04-15得票数 0
回答已采纳
1回答
(反)序列化类似于Microsoft的已知类型
c#、.net、json、serialization
到目前为止，我已经使用微软的将我的业务对象序列化和反序列化为格式为JSON的数据传输对象。DTO使用属性进行标记。下面是一个小示例：
[DataContract(Name = "Geometry", Namespace = "myContract.com/dto")]
[KnownType(typeof(Point))]
[KnownType(typeof(Line))]
public class Geometry
{
}
[DataContract(Name = "Point", Namespace = "myContract.com
浏览 0提问于2015-05-20得票数 4
2回答
VB.Net:用参数动态调用模块方法或例程
vb.net、string、methods、module
我想使用变量名运行一个方法，该变量名存储在带有参数的模块中：
Dim subName as String = "sub1"
Dim param as Integer = 123
sub1(param) <- I want to run this using the **subName** string
我不想使用Select Case，因为这些方法位于许多不同的模块中，我不想维护一个选择用例函数。
我查找了CallByName，但似乎这只适用于类。当涉及到ObjectRef模块( Modules )时，我不知道如何设置对象：
Public Function CallByN
浏览 3提问于2016-09-20得票数 1
回答已采纳
1回答
创建函数时出现MYSQL服务器错误
mysql、mysql-error-1064
当我运行query时，我有一个函数，当我收到这个错误时
create FUNCTION createBuffer( POINT，distancia INT )return POLYGON BEGIN /** ** @description :以米为单位创建圆和半径的函数* @author : Fernando Norte (fnorte at gmail dot com) ** @params : ponto (geometry)，distancia (以米为单位)* @return : Polygon (geometry) * **/ SET @angle =0；
MySQL说:文档
106
浏览 0提问于2014-12-09得票数 0
1回答
如何参考青色二头肌模块中的父源？
azure、azure-devops、azure-pipelines、azure-bicep
我试图创建一个服务总线和主题(许多主题和他们的订阅)与蔚蓝二头肌。
我有主二头肌，如下所示
param主题数组；资源'Microsoft.ServiceBus/namespaces@2018-01-01-preview‘={名称: serviceBusNamespaceName位置: location：{ name: skuName }模块topicSubscription’./sb_topic.biep‘=serviceBusNamespaceName中的主题：{ name：’topicSubscription${serviceBusNamespaceName}‘params：{se
浏览 6提问于2022-09-21得票数 0
回答已采纳
6回答
使用类或接口方法的类型
angularjs、typescript
为了给这个问题提供一些上下文，我有一个子组件，它调用其父组件提供的回调。这是AngularJS.中的一个典型场景
由于我使用的是TypeScript，所以希望在子组件中强烈键入回调。
以下是没有任何强类型的初始状态：
class ParentComponentController {
public parentMethod(param1: number, param2: string): boolean {
return param1 > 0 && param2.length > 2;
}
}
class ChildComponentControl
浏览 6提问于2017-04-16得票数 2
回答已采纳
1回答
DO2没有区分“Unitmyname”和“structmyame”
c、doxygen
我编写了一个小型的矩阵库，作为我正在进行的一个更大项目的一部分。实现零成本转移是很重要的，所以我使用/滥用了联合。代码本身工作正常(如下所示)，但是当它使用DO2文档时，它将struct matrix_r和union matrix_r的所有文档合并到一个项目中。也就是说，只有为struct matrix_r和struct matrix_c生成的页面，但这两个页面将matrix_r和matrix_c描述为联合，具有连接的@简短文本和连接属性(来自结构和联合声明)。
我对how非常非常陌生，但到目前为止，我还无法弄清楚如何将它们作为单独的文档项目来处理。有什么想法吗？
#include <s
浏览 0提问于2017-11-25得票数 1
回答已采纳
4回答
我们现在正在学习如何在Java中使用多个类，有一个项目要求创建一个包含radius和diameter的类Circle，然后从一个主类引用它来查找直径。此代码继续收到一个错误(在标题中提到)
public class Circle
{
public CircleR(double r)
{
radius = r;
}
public diameter()
{
double d = radius * 2;
return d;
}
}
谢谢你的帮助，-AJ
更新1：好的，但是我不应该将第三行public Ci
浏览 8提问于2011-09-17得票数 8
回答已采纳
1回答
用蒙特卡罗方法计算带流Java中Pi的逼近值
java、numerical-methods
我有一个简短的程序，它试图计算一个大约值\$\pi\$：
package net.coderodde.fun;
import java.awt.geom.Point2D;
import java.util.Arrays;
import java.util.Objects;
import java.util.Random;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
/**
* This class computes an approximate value of Pi.
*
* @a
浏览 0提问于2018-02-23得票数 4
回答已采纳
6回答
我是一个C#初学者(3天的经验)。今天，我将在C#中练习继承。这是我的代码：
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
namespace Geometry
{
public class Geometry
{
public double perimeter;
public double area;
public bool special;
}
public class Rect
浏览 7提问于2017-06-12得票数 0
回答已采纳
1回答
考虑数据/对象的反对称性，如何解决可扩展性问题？
design、clean-code、polymorphism、extensibility、multiple-dispatch
鲍勃叔叔在“清洁守则”第124-125页中说
过程代码(使用数据结构的代码)使得在不更改现有数据结构的情况下很容易添加新函数。另一方面，OO代码可以在不改变现有函数的情况下轻松地添加新类。
我正在阅读类似于这篇关于多重分派的文章中的多个like，并想知道它是否解决了这个问题。
约尔格·米塔格说这被称为表达问题菲尔·瓦德勒，但是他说为了解决这个问题，我们应该
按情况定义数据类型，在这种情况下，可以通过数据类型向数据类型和新函数添加新案例，而无需重新编译现有代码，同时保留静态类型安全...。
我更感兴趣的是软件的可扩展性，即是否“容易”递增添加新功能。在本例中，我对“轻松”有一个直观的定义，它包括
浏览 0提问于2018-04-27得票数 7
2回答
JSDOC:如何记录函数的内部变量
jsdoc、jsdoc3
是否有一种方法可以让JSDOC在函数内部显示变量，而无需在函数之前使用@命名空间注释？
我做了一个小的测试对象，但是它只显示最后一个函数的内部变量k，这个函数被声明为一个命名空间。我认为使用@memberof!注释和精确的@name注释将在下面名为diff的第二个方法中显示内部变量。我在命令上运行jsdoc3，选项为--访问"all“--解释。
下面是测试对象的代码：
(function(){
"use strict";
/**
* @namespace
* @type {{}}
*/
window.myFuncti
浏览 3提问于2016-02-21得票数 2
1回答
C2061错误：“标识符”，但是我包含了标题？
c++、visual-studio、syntax-error
我正在处理一个VC++项目(仅使用Visual进行编辑，没有任何视觉效果)。在我的一个类中，我有一堆C2061错误，但是每件事都很好，我进行了两次和三次检查。这是发生错误的类: Circle.h：
#ifndef __SGE__Circle__
#define __SGE__Circle__
#include <GLFW/glfw3.h>
#include "Vector2.h"
#include "Rectangle.h"
class Circle
{
public:
Circle();
Circle(float xCenter,
浏览 2提问于2015-04-23得票数 0
回答已采纳
1回答
泛型类型的VB.Net搜索命名空间(反射)
.net、vb.net、entity-framework、reflection
我正在尝试使用上下文动态注册实体和配置(仅限ef4代码)
我通常会这样做：
Private Shared Sub ConfigureDatabase(ByRef Builder As ContextBuilder(Of ContextExtension))
'Load configurations for each of the tables (Entity sets) in our database...
ConfigureEntity(Builder, New ContactConfig)
End Sub
Private Shared Sub ConfigureEnti
浏览 0提问于2010-09-27得票数 1
回答已采纳
1回答
Hibernate空间和遗留数据库
java、hibernate、hibernate-spatial
背景：
我有遗留数据库，不能更改它的架构。我的实体的映射如下：
class SomeObject {
@Column(name = "LONGITUDE", nullable = false)
public BigDecimal longitude;
@Column(name = "LATITUDE", nullable = false)
public BigDecimal latitude;
...
}
问题：
我需要创建hibernate查询，它将选择一个循环中的所有SomeObjects。我通过，hibernat
浏览 2提问于2016-12-16得票数 0
回答已采纳
1回答
使用perl XML::LibXML解析
perl、libxml2
我使用perl的XML::LibXML模块解析来自设备的XML响应。看来，成功获取数据的唯一方法是修改设备上的XML响应。下面是我来自设备的XML响应：
<chassis-inventory xmlns="http://xml.juniper.net/junos/10.3D0/junos-chassis">
<chassis junosstyle="inventory">
<name>Chassis</name>
<serial-number>JN111863EAFF</serial-num
浏览 1提问于2011-08-12得票数 4
回答已采纳
2回答
doxygen创建时出错
c++、doxygen
我在我的c++项目中使用doxygen来生成文档。我的项目包含类函数和过程调用，
//AAA.h
namespace NAME
{
Class EXPORT AAA
{
/*!
* \brief Sample function.
*
* \param a is an integer value.
*
* This is a sample function.
*/
void SampleFunction(int a);
}
}'
在构建了这段代码之后，doxygen运行良好，并获得了详细的
浏览 16提问于2012-06-14得票数 1
1回答
我在一个名为Main.hx的文件中有一个主Haxe脚本。在同一个脚本中，我可以导入任何存在的包，包括在被认为是包的目录中的其他Haxe脚本，但是在嵌套目录中声明的Haxe脚本(应该被认为是包)不适用于import (我几乎可以肯定它们被忽略了)。
哈克斯只是在说Test不存在。当我试图得到wow.test.Test时，它会说同样的话，对test.Test也是如此。我还尝试将./wow/test.hx中的包名设置为wow.test和test，情况也是一样的。
只有当我将test.hx抛出./wow之外并正常导入它的东西时，它才能工作，比如：test.*而不是wow.test.*。
我的测试结构
浏览 5提问于2016-12-04得票数 1
回答已采纳
6回答
蒙特卡罗π计算
python、python-3.x、numerical-methods
为了学习蒙特卡罗的基础知识，我用它计算了圆周率。我还解释了代码背后的推理。
在这里，您可以看到带有随机点的圆圈，这是我在代码中模拟的。
📷
"""
This programme calculates pi with Monte Carlo
Given a square and a circle inside it.
We have
Area_of_the_square = LENGTH ** 2
Area_of_the_circle = radius ** 2 * pi => (LENGTH ** 2) / 4 * pi
The circle
浏览 0提问于2014-11-10得票数 26
回答已采纳
1回答
在SugarCRM中设置模块字段的默认值
php、sugarcrm、sugarbean
我的SugarCRM环境中有一个名为SugarCRM的模块，它有几个字段，如name、id、account_name、date_created、description等等，还有一个名为custom_account_number的自定义字段。
我想将其值设置为account_name字段之一，如何使用自定义文件夹中的自定义php脚本来实现？
浏览 0提问于2016-09-07得票数 2
回答已采纳
扫码
添加站长 进交流群
领取专属 10元无门槛券
手把手带您无忧上云
相关资讯
热门标签
云服务器
即时通信 IM
ICP备案
对象存储
实时音视频活动推荐
腾讯云开发者
