javascript - 如何在jsdoc上添加和使用标签？

In lại 作者：搜寻专家 更新时间：2023-11-01 04:18:39 28 4

exports.defineTags = function(dictionary) {
    dictionary.defineTag("methodHttp", {
        mustHaveValue: true,
        canHaveType: false,
        canHaveName: true,
        onTagged: function(doclet, tag) {
            doclet.methodHttp = tag.value;
        }
    });
};

{
    "tags": {
        "allowUnknownTags": true
    },
    "source": {
        "includePattern": ".+\\.js(doc)?$",
        "excludePattern": "(^|\\/|\\\\)_"
    },
    "plugins": [ "plugins/method" ],
    "templates": {
        "cleverLinks": false,
        "monospaceLinks": false,
        "default": {
            "outputSourceFiles": true
        }
    },
    "jsVersion": 180
}

self.find('methodHttp')[0]
data.methodHttp[0]
data.methodHttp

28 4 0

• jsdoc - 是否有关于如何创建自己的 jsdoc 模板的详细文档？

  短版: 如果我想从头开始开发一个全新的 jsDoc 模板，我需要阅读哪些内容才能了解 jsDoc 的功能、我的模板必须提供什么接口(interface)以及我可以使用哪些数据？ 加长版: 我已经使用

• jsdoc - 如何使用 JSDoc 记录回调？

  给定一个将回调函数作为参数的 Javascript 函数: var myFunction = function(onSuccess, onFailure) {...} 我如何记录 onSuccess的

• jsdoc - "valid"JSDoc 是否需要星号？

  我一直看到以下格式的 JSDoc(和之前的 JavaDoc): /** * This is some JSDoc ... * ... and some more */ function

• jsdoc - 在 JSDoc 中记录对对象/函数的更改的正确方法是什么？

  假设我有一个接受一个参数的函数: /** * @summary Some function. * * @since 1.0.0 * * etc. */ function func( a )

• jsdoc - 长 JSDoc 行的正确/规范格式是什么？

  所有官方 JSDoc 示例都有简单的文档字符串，如下所示: /** * @param {string} author - The author of the book. */ 问题是，在现实生活中

• jsdoc - 使用 jsDoc 突出显示文本/代码

  jsDoc 似乎支持大部分 MD 语法，但是当涉及到突出显示单个保留字或文本时，我找不到可用的标签。 在 MD 语法中，我可以使用 `word`，它会设置灰色背景和不同的字体，这样您就可以清楚地看到它

• javascript - JSDoc 注释中的 JSDoc 注释

  我正在提供带有 JSDoc 注释的代码示例，其中也包含 JSDoc 注释，如何在不破坏外部注释的情况下转义嵌套的 JSDoc 注释？ 我使用的是版本 3.3.0-beta3 例子: /** *

• jsdoc - 如何使用 JSDoc 记录 ES6 类属性

  我正在使用 documentation package ，但无法弄清楚如何将它记录为类属性(不是通过 getter 和 setter 定义的)。 下面只为 SomeClass 生成类文档，但省略了 s

• jsdoc - 如何用 jsdoc 描述 js 模块

  请向我解释描述此模块的最佳方式: /** * Common util methods * @module Utils */ var Utils = (/** @lends module:Util

• jsdoc - 如何让@borrows 标签在 JSDoc 中工作

  我一直很难让 @borrows 标记在 JSDoc 中工作。我一直在尝试从一个函数中获取文档，并将其作为第二个函数的文档。但我似乎连一个简单的例子都做不到! /** * This is the de

• javascript - 咕噜 JSDoc : Use jsdoc JSON file

  我想设置一个 Grunt 任务来运行 JSDoc。我正在使用 grunt-jsdoc JSDoc npm 页面推荐的。它工作正常，但我不能使用我创建的 jsdoc.json 文件。 { "tags

• jsdoc - 求: Example of how to use jsDoc with the Webstorm IDE (v 4)

  我仍在学习 js 并试用 Webstorm IDE，它看起来不错(包括跳转到 var/函数声明)。 我可以看到如何让 jsdoc 评论出现的模板，但我没有这方面的经验，正在寻找一个例子来说明如何在评论

• jsdoc - 求: Example of how to use jsDoc with the Webstorm IDE (v 4)

  我仍在学习 js 并试用 Webstorm IDE，它看起来不错(包括跳转到 var/函数声明)。 我可以看到如何让 jsdoc 评论出现的模板，但我没有这方面的经验，正在寻找一个例子来说明如何在评论

• javascript - 如何使用 jsdoc 3 或 jsdoc 记录 Requirejs (AMD) 模块？

  我有两种类型的模块: Require.js 主文件: require.config({ baseUrl: "/another/path", paths: {

• jsdoc - 如何在jsDoc中制作方法参数类型的链接

  是否有任何自然方式或特殊标签将参数类型作为链接？ /** * My js app * @module app */ /** * Namespace for MYAPP classes and func

• jsdoc - 为多种功能重用文档？

  我有一个包含大量选项的函数: /** * Show dialog in a blocking manner. * * @param {object} opts * @param {string

• jsdoc - 如何在ubuntu的整个目录上运行jsdoc

  我只需要在包含 .js 文件的 ai 整个目录上运行 jsdoc，我通过发出命令 jsdoc abc.js 对 ubuntu 终端中的单个文件执行此操作，但我需要的是一次将此命令应用于目录中的所有文件

• JSDoc 继承参数文档

  假设我有两个功能，其中一个扩展了另一个。 /** * @abstract * @param {Object} settings * @param {Number} settings.x * @para

• jsdoc - 原始类型名称需要大写还是小写？

  /** * @param {String} foo * @param {Number} bar */ 或者 /** * @param {string} foo * @param {numbe

• jsdoc - 如何在JsDoc中忽略源链接？

  导致JsDoc忽略源链接的最简单方法是什么？我必须定义自己的模板吗？ 最佳答案 如果使用默认模板，则使用templates.default.outputSourceFiles设置为false的配置文件