`
need_faith
  • 浏览: 81108 次
  • 性别: Icon_minigender_1
  • 来自: 北京
社区版块
存档分类
最新评论

Jsdoc注释标签

 
阅读更多
  • {@link ...}, {@linkplain ...}, {@linkcode ...}, {@tutorial ...} 内联标签
  • @abstract 抽象,必须由继承者实现(或者覆盖)
  • @access 访问级别(private、public或者protected)
  • @alias 别名
  • @augments 参数
  • @author 作者
  • @borrows 借用
  • @callback 回调函数
  • @classdesc 类描述
  • @constant 常量
  • @constructor 构造函数,可以使用new创建一个实例
  • @constructs 构造
  • @copyright 版权
  • @default 默认值
  • @deprecated 弃用的
  • @desc 描述
  • @enum枚举值
  • @event 事件
  • @example 范例
  • @exports 模块导出(模块化)
  • @external 外部模块(模块化)
  • @file 文件
  • @fires 可触发的事件
  • @global 全局对象
  • @ignore 忽略
  • @inner 内联对象
  • @instance 实例
  • @kind 标识类型
  • @lends 遍历属于同一个标识的所有属性
  • @license 软件授权
  • @link 内联
  • @member 成员
  • @memberof 属于某成员
  • @method 方法
  • @mixes 合并
  • @mixin 最小化
  • @module 模块(模块化)
  • @name 名称
  • @namespace 命名空间
  • @param 参数
  • @private 私有的(访问控制)
  • @property 属性
  • @protected 受保护的(访问控制)
  • @public 公开的(访问控制)
  • @readonly 只读的
  • @requires 依赖(模块化)
  • @return 返回值
  • @see 引用
  • @since 开始于
  • @static 静态的
  • @summary 概述
  • @this 解释this关键字
  • @throws 可能抛出的异常
  • @todo 待办事项
  • @tutorial 引用指导手册
  • @type 类型
  • @typedef 自定义类型
  • @variation 区分不同的对象具有相同名称的
  • @version 版本
分享到:
评论

相关推荐

    JsDoc-Toolkit标签一览表

    JsDoc Toolkit 是一个把js描述格式化成文档的工具。开发者只需按JsDoc的规范写好注释就可以很方便导出文档。它是google 推荐的JsDoc生成工具。

    ts2jsdoc:带有可选模板的 JSDoc 插件,可根据 Typescript 定义自动添加 JSDoc 注释

    ts2jsdoc 带有可选模板的 JSDoc 插件,可根据 Typescript 定义自动添加 JSDoc 注释。概述特征根据 Typescript 的类型自动添加 JSDoc 注释: 添加变量和属性类型、修饰符和默认值。 添加函数和方法返回类型、修饰符、...

    coc-docthis:coc.nvim的JSDoc扩展,可为TypeScriptJavaScript文件生成详细的JSDoc注释

    coc-docthis coc.nvim的JSDoc扩展名,可从派生为TypeScript / JavaScript文件生成详细的JSDoc注释。安装:CocInstall coc-docthis 指令docthis.documentThis :在当前位置生成文档构型配置描述默认docthis.returnsTag...

    vscode-docthis:Visual Studio Code的JSDoc生成器扩展

    “ Document This”是Visual Studio Code扩展,可以自动为TypeScript和JavaScript文件生成详细的JSDoc注释。 标签 支持JSDoc和Closure Compiler标签:@ class,@ description,@ enum,@ export,@ function,@ ...

    jsdoc-plugins:各种 JSDoc 3 插件

    从代码注释的角度来看, @default标签在查看内联时并没有增加太多价值。 然而,它在帮助生成的文档中确实有价值。 此插件允许您不必在不用于复杂数据类型的 DocBlocks 中包含@default标记,并在文档生成期间自动将...

    ts2swagger:从TypeScript类创建Swagger API

    将类,接口和方法以及JSDoc注释读入Swagger文档 使用TypeScript定义参数和返回值模型 定义在特定错误代码处返回的类型 使用标签对功能进行分组 作为私有服务对象成员的Request和Response (不污染接口签名) 仅重写...

    tsdoc:TypeScript的文档注释标准

    文档链接 -项目概述和路线图 -其他开发人员的实时帮助 -了解语法元素,如@param , @remarks等。 解析器引擎的交互式演示 -如何在此仓库中构建和调试项目 提出拉取请求的说明 此monorepo中的项目 ...

    程序员需要经常刷题吗-doctor:从JavaScriptAST创建文档(或其他有用的信息)

    源代码转换为文档,使用规则依赖约定,以便(大部分)不需要注释标签。 说什么? 也许一张图片会有所帮助: 好吧,也许这需要一些解释。 源文件使用 JavaScript 语法进行解析。 这推出了一个普通的 Lisp 式 AST。 这...

    parser:为SFC Vue组件生成JSON文档。 贡献

    Vuedoc分析器 为Vue文件组件生成JSON文档。 目录 道具专用标签 道具输入界面 注释数据 注释计算的属性 注释方法 注释事件 注释广告位 忽略解析项目 ...支持的标签 ...JSDoc支持( @type , @param , @retur

    idtsc:内部 .d.ts 清理。 将标有 `@internal` 的类属性变为私有

    身份证 idtsc(ⅰnternal。d。TSÇleanup)。 这是隐藏/保护内部属性和方法的后处理步骤。 转换用@internal 标记的类属性: 私有化 ... 要将您的属性、方法和类标记为内部,只需添加一个 jsdoc 标签:

    conrad.js:一个很小的 ​​JavaScript 调度器

    conrad.js conrad是一个小型 JavaScript 调度程序,由在。 它是在下。 完整的 API 文档可。... 使用npm install安装conrad开发... 整个源代码由Google Closure Linter验证,注释是用JSDoc编写的(标签描述可在此处获得)。

    eclipse-typescript:用于使用TypeScript语言进行开发的Eclipse插件

    然后选择配置->启用TypeScript构建器特征代码完成保存时编译跨项目编译错误注释/标记查找参考格式码突出显示匹配括号将鼠标悬停在JSDoc上标记出现开放的定义轮廓图快速概述重命名重构语法高亮任务标签切换评论附加...

Global site tag (gtag.js) - Google Analytics