如何记录具有多个别名的方法?

2023-12-24

我正在尝试记录获取名称()以下 Person 构造函数的方法:

JavaScript 代码:

/**
 * Creates a person instance.
 * @param {string} name The person's full name.
 * @constructor
 */
function Person( name ) {

    /**
     * Returns the person's full name.
     * @return {string} The current person's full name.
     */
    function getName() {
        return name;
    }

    this.getName = getName;
    this.getN = getName;
    this.getFullName = getName;
}

如您所见,获取名称()方法有两个别名(getN() and 获取全名()),所以明显要使用的标签是@alias http://usejsdoc.org/tags-alias.html标签,但不幸的是,它有两个主要问题:

1-它告诉 JSDocrename方法。

2-它不能用于多个别名.

有没有官方的方法来记录这些方法?


这个问题的答案可能听起来有点有趣,但实际上,有一种官方方法来记录方法别名,他们称之为@borrows http://usejsdoc.org/tags-borrows.html .

The @borrows标签允许您添加另一个符号的文档 你的文档。

如果您有此标签将会很有用不止一种方式来引用 功能,但您不想在中重复相同的文档 两个地方。

So, the 获取名称()应记录如下:

JavaScript 代码:

/**
 * Creates a person instance.
 * @param {string} name The person's full name.
 * @constructor
 * @borrows Person#getName as Person#getN
 * @borrows Person#getName as Person#getFullName
 */
function Person( name ) {

    /**
     * Returns the person's full name.
     * @return {string} The current person's full name.
     * @instance
     * @memberof Person
     */
    function getName() {
        return name;
    }

    this.getName = getName;
    this.getN = getName;
    this.getFullName = getName;
}

JSDoc 结果:

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

如何记录具有多个别名的方法? 的相关文章

  • 将二进制转换为十六进制

    我正在将二进制转换为十六进制 但下面的代码返回错误的答案 var number 1011 var hexa parseInt number 2 toString 16 return hexa 这返回b但应该必须退货B 问题是什么 b is正
  • 使用 AJAX 来回发送信息

    使用 post 你可以向服务器发送信息 但是当你需要从服务器接收信息时怎么办呢 信息如何从可以由 php 变量保存的方式变为可以由 javascript 变量保存的方式 反之亦然 这与您的问题更相关 http docs jquery com
  • 从数组数组中获取唯一值[重复]

    这个问题在这里已经有答案了 我有以下数组 let arr email protected cdn cgi l email protection email protected cdn cgi l email protection email
  • Object.assign() - 奇怪的行为需要解释

    我有这个代码 function margeOptions options passedOptions options Object assign options passedOptions let passedOpts a true let
  • TypeScript 中类和命名空间的区别

    到底有什么区别classes and namespaces在打字稿中 我知道 如果您创建一个带有静态方法的类 您可以在不实例化该类的情况下访问它们 这正是我猜想的命名空间的要点之一 我还知道你可以创建多个同名的命名空间 并且它们的方法在编译
  • 通过电子邮件发送在 HTML5 画布上创建的图像

    我有一个画布 用户可以通过交互来更改设计 现在 用户完成更改后 可以提交他的设计及其电子邮件 ID 但为了提交设计 我使用以下方法将画布转换为图像http www nihilogic dk labs canvas2image http ww
  • JQuery _renderItem 没有被调用

    我正在尝试使用 renderItem 函数创建自定义 ui menu item 元素 但经过可能尝试后 我什至无法调用该函数 自动完成功能正在工作 但就像 renderItem 函数不存在一样 这是我的脚本部分
  • Django 模板变量从 {% for %} 循环到 Javascript

    这是一个迭代记录的 Django 模板 每条记录都包含一个由 JS 函数填充的 div 为了让 JS 知道要做什么 它需要从每次 for 循环迭代中获取一个变量并使用它 我不知道具体如何实现这一目标或是否可能 我不知道 也许记录在单独的 J
  • 从 UnityWebGL jslib 返回字符串

    我想使用 jslib 来获取网址参数 像这样的代码 jslib GetUrl function var s var strUrl window location search var getSearch strUrl split var g
  • 传单 - 导入 Geojson - Angular 6

    我尝试将 GeoJson 文件导入到 Angular 的应用程序 6 中的传单中 通过这个解决方案 我的 geojson 是在 leafletmap 中绘制的 但我有这个错误 我无法构建我的应用程序 有人知道一种解决方案吗 错误 TS234
  • jQuery live() 和ready() 之间的区别?

    两者之间的确切区别是什么live and ready 编辑 发现die http docs jquery com Events die是相反的live ready http docs jquery com Events ready让你注册一
  • Node.js - Async.js:并行执行如何工作?

    我想知道 async js 中并行执行是如何工作的 async require async async parallel function callback for var i 0 i lt 1000000000 i Do nothing
  • 当元素具有多个类时如何在 switch 语句中检查 className

    在下面的示例中 我只想单击该选项以在警报中显示 我正在尝试使用 switch 语句来确定单击了哪个类 如果我的 div 不包含多个类 则我的示例将有效 我尝试使用classList contains在我的 switch 语句中无济于事 有没
  • 是否可以从 webpack 中的文件名中删除特殊字符?

    长话短说 我的资产文件名中不能包含某些字符 例如连字符 我没有运气通过解析 webpack 文档来弄清楚是否可以使用正则表达式或类似的东西重命名文件 这样我就可以从我无法控制源文件名的 3rd 方包中删除任何连字符 我的超级天真的例子是这样
  • router.navigate 使用查询参数 Angular 5

    我在使用查询参数路由到路由时遇到问题我有一个像这样的函数 goToLink link this router navigate link split 0 queryParams this sortParams link 和这个功能 sort
  • 在 HTML5 画布上创建颜色选择器

    如何在 HTML5 画布上绘制颜色选择器 一个基本的例子是使用getImageData http jsfiddle net eGjak 60 http jsfiddle net eGjak 60 var ctx cv get 0 getCo
  • 为什么对于整数键,“Map”操作比 JavaScript (v8) 中的“Object”慢得多?

    我很高兴使用Map对于在我的 JavaScript 代码库中随处访问的索引 但我刚刚偶然发现了这个基准 https stackoverflow com a 54385459 365104 https stackoverflow com a
  • 如何制作饼图聚合数据源?

    Using 适用于 ASP NET MVC 的 Kendo UI 完整版 http www kendoui com 版本 2013 3 1119 2013年11月20日 如果我有这段代码 status chart kendoChart da
  • ES6解构对象赋值函数参数默认值

    您好 我正在查看在传递函数参数时使用对象解构的示例对象解构演示 https developer mozilla org en US docs Web JavaScript Reference Operators Destructuring
  • 通过jquery ajax()和serialize()提交html表单

    我想通过 jquery ajax 提交此表单 这是我所做的 但它不起作用 即表单正在提交并刷新页面 但我没有看到响应 即在同一页面上打印数组 HTML

随机推荐

  • 如何在模型 ir.actions.server odoo 12 中给出用户组(XML)?

    我使用这个 xml 代码在 操作 内添加一个按钮 但我需要将该按钮限制为某些用户组
  • Objective C:向视图控制器添加加载视图

    在我的应用程序中 我的许多页面都需要一个加载屏幕 如何创建与下面的屏幕截图类似的加载效果 检查 MBProgressHUD https github com jk MBProgressHUD https github com jk MBPr
  • 如何以编程方式更改列表视图高度..?

    我想知道如何以编程方式更改列表视图的高度 是否可以更改单个列表项的子项高度 ViewGroup LayoutParams params listView getLayoutParams params height whatYouWant l
  • 通过Python中的服务帐户访问Google Cloud Storage的权限

    我正在尝试获取一个服务帐户来在 Google Cloud Storage 中创建 blob 来自 Python 脚本 但我遇到了凭据问题 1 我为我的项目创建服务帐户 然后下载 json 格式的密钥文件 home user config g
  • 为什么数组需要 ClassTags 而 List 这样的集合不需要?

    这工作正常 def x A a A List a 没有适用于 A 的 ClassTag def y A a A Array a 但这当然是犹太洁食 def y A ClassTag a A Array a 是什么赋予了 数组在运行时保留其类
  • 按文件夹对伊斯坦布尔代码覆盖率报告进行分组

    我正在使用 istanbul 和 nyc 命令运行 NodeJs 的代码覆盖率报告 我使用 mocha 进行单元测试 我按照预期得到了每个文件的报告 但我希望看到的是具有单个目录摘要的报告 让我更详细地解释一下我得到了什么以及我想看到什么
  • ValueError:在 LightGBM 中检测到循环引用

    训练LightGBM模型时出现以下错误 Train the model import lightgbm as lgb lgb train lgb Dataset x train y train lgb val lgb Dataset x t
  • IE8 的 calc() 是否有仅 CSS 的后备方案

    我知道有一个CSS 后备calc 适用于IE6 7 https stackoverflow com questions 16034397 css calc alternative 同样 我知道有jQuery 的替代品 https stack
  • Android - 按下主页键时关闭应用程序

    我制作的这个应用程序运行良好 但是当我离开该应用程序并再次打开它时 它总是强制关闭 我怎样才能做到当用户按下主页和 或返回键时它会杀死应用程序进程 使得当应用程序再次打开时它有一个全新的开始 您不应该 终止进程 您应该处理主页按钮按下和其他
  • Azure API 管理(策略)

    我需要帮助为我的一项任务制定 APIM 策略 我有两个有效负载 从外部服务获取 UniqueID 并验证 Webhook 来自该外部服务 发送请求时 其他有效负载将进入请求正文 这两个有效负载有些不同 因此当我将来自外部服务的有效负载放入其
  • 表面视图示例

    所以我花了大约两天的时间试图找到一份工作SurfaceView 我在网上遵循的教程即使严格遵循也不起作用 我通常会看到全黑的屏幕 为了帮助自学它是如何工作的 我需要一个工作SurfaceView程序 我正在寻找一个具有以下功能的程序Surf
  • 在 zend 框架下载中找不到 zf.bat [重复]

    这个问题在这里已经有答案了 可能的重复 Zend Framework 2 bin 文件夹中 Zend Tool Missing https stackoverflow com questions 10778626 zend framewor
  • 不使用 matlab 头文件和库编写 MAT 文件

    我有一些数据想要保存到 MAT 文件 版本 4 或 5 或任何版本 问题是 我想在不使用 matlab 库的情况下完成此操作 因为此代码不需要在装有 matlab 的机器上运行 我的程序使用 Java 和 C 因此这些语言中实现此目的的任何
  • openssl:减少内存使用

    再会 我们有一个用 C 编写的服务器 它接受许多 SSL TLS 连接 我们正在使用 boost asio 所以后端是openssl 建立 SSL 目前 服务器每个连接使用大约 160 200kbyte 的内存 我们希望减少这种使用量 bo
  • Android 有没有办法判断用户设备是否有实际键盘?

    我想检测当前用户的手机是否有硬件键盘或只有屏幕键盘 通过 SDK 可以实现吗 是的你可以 获取配置 http developer android com reference android content res Configuration
  • 为什么我的 Bootstrap 表会溢出包含卡?

    实际上我正在尝试在引导卡内设置一个表格 问题是表格宽度超出了该卡的范围 我会阻止它 该表是针对 1 th 和 96 td 的每个 tr 制作的 我试图将表格宽度设置为 100 并设置为每个 td 宽度的 1 但我没有成功 这是表代码 div
  • 重新分配返回 NULL

    int main struct lottery array array struct lottery malloc 3000 sizeof struct lottery int opt counter menu1 scanf d opt i
  • python中LMAX架构中的业务逻辑imp

    I am trying to implement disruptor in Lmax https martinfowler com articles lmax html architecture As you know in lmax ar
  • Node.js 中的同步 TCP 读取

    有没有办法在node js中同步读取TCP套接字 我很清楚如何通过向套接字的 数据 事件添加回调来异步执行此操作 socket on data function data now we have the string data to do
  • 如何记录具有多个别名的方法?

    我正在尝试记录获取名称 以下 Person 构造函数的方法 JavaScript 代码 Creates a person instance param string name The person s full name construct