文档建议反馈控制台
首页
学习
活动
专区
圈层
工具
MCP广场
文章/答案/技术大牛
发布

Angular 工具篇之文档管理

文档注释 comments Compodoc 使用 TypeScript AST 解析器和它的内部 API，因此注释必须是合法的 JSDoc 注释。...JSDoc Tags 由于 TypeScript 编译器的限制 目前 Compodoc 只支持以下的 JSDoc 标签： @returns —— 描述返回值 @ignore —— 表示标记的内容永远不会出现在文档中...标签生成对应的文档之外，它还能为我们自动生成项目概况、路由信息、组件信息及文档覆盖率等。...总结 本文简单介绍了如何利用 Compodoc 这款工具，为 Angular 应用程序生成静态文档，Compodoc 基本上能够满足我们的需求。...对 Angular 项目来说，除了 Compodoc 之外，你也可以考虑使用谷歌官方出品的 API 文档生成工具 Dgeni，它对外开放了丰富的接口，还支持插件扩展，具有非常强的定制性。

2K10

JSDoc ，一个可替代 TypeScript 的方案？

本文将向您展示如何使用JSDoc来获得相同类型的控制，同时使用纯JavaScript进行最快的开发时间和更好的文档编写！ JavaScript已经巩固了其作为近年来最常用的脚本语言之一的地位。...JSDoc相对于TypeScript的优势: 灵活性和兼容性：JSDoc只是JavaScript注释，这意味着它可以添加到任何JavaScript代码库中，而不受语言版本的限制，并且不像TypeScript...代码注释：JSDoc不仅可以用于类型检查，还可以用于添加更多的文档，描述函数的工作原理，并生成文档网站，从而提供价值以增强代码的可维护性和理解性。...如何使用JSDoc：基础知识 由于其长期存在，JSDoc在所有现代编辑器中都得到了广泛支持，并且可以直接使用，无需任何安装。...在一个 .js 文件中添加JSDoc，如所述只是注释，通过使用额外的 * 开启一个注释来完成 // Normal Javascript Comment 1 /* Normal Javascript Comment

1.6K10
    • 您找到你想要的搜索结果了吗？
    是的
    没有找到

    为你的 JavaScript 项目添加智能提示和类型检查

    基于 JSDoc JSDoc 是目前最通用的 JavaScript API 文档生成器，根据其语法编写代码注释，可以十分方便地自动生成文档。...JSDoc 注释使得阅读和理解代码更加方便（代码交接时再也不用抓狂了，当然前提是注释写得好），也保障了开发时的体验并且降低了很多运行时才能发现的数据类型方面的 bug。...基于 TypeScript 类型声明文件 除了使用 JSDoc 提前声明类型，更为激进的做法是直接使用微软开发的 TypeScript，为整个项目带来完善的静态类型检查。...不严格地来说，ts 类型声明文件就像用 TypeScript 语法将 JSDoc 的注释重写了一遍并提取到了单独的文件中。...VSCode 更是将二者作了融合，当你二者混用的时候，可以直接在 JSDoc 的注释中直接使用 ts 类型声明文件中定义的 interface 和 class 等。

    4.4K20

    不是Typescript用不起，而是JSDoc更有性价比？

    而 Stack Overflow 发布的 2023 年开发者调查报告也显示，JavaScript 连续 11 年成为最流行编程语言，使用占比达 63.61%，TypeScript 则排名第五，使用占比..._clock = clock; } } 在实践中，多用于配合 jsdoc2md 等工具，自动生成库的 API 文档等。...随着前后端分离的开发范式开始流行，前端业务逻辑也日益复杂，虽然不用为每个应用生成对外的 API 文档，但类型安全变得愈发重要，开发者们也开始尝试在业务项目中使用 jsdoc。...的类型声明定义成 TS 风格，更是支持了在 JSDoc 注释的类型声明中动态引入并解析 TS 类型的能力。...在通常的情况下，ProtoBuf（Protocol Buffers）的设计思想是先定义 .proto 文件，然后使用编译器生成对应的代码（例如 Java 类和 d.ts 类型定义）。

    1.1K10

    有JSDoc还需要TypeScript吗

    如果你在编写CLI脚本，你可以求助于Deno（它支持TypeScript，开箱即用），但是你需要设置你的IDE来理解Deno的API，而且混合和匹配Deno和node并不总是那么容易。...一旦你在本地完成了所有工作，你就需要考虑如何分发你的代码。你会检查你编译的.js文件吗？你会创建一个CI管道来自动编译你的.ts文件吗？如果你在写一个库，你如何发布你的库，以便它可以被其他项目使用？...你可以通过使用JSDoc在JavaScript中获得TypeScript的所有好处 TypeScript所提供的是一个静态类型系统。这意味着类型信息在运行代码中没有影响。...」 较少人知道的是，JSDoc是你充分使用TypeScript所需要的。...建议 所以现在我的建议是这样的： 当你正在做一个有编译步骤的项目时，使用TypeScript没有什么坏处 但是如果你不需要编译步骤，那么坚持使用JSDoc类型注释可能更容易。

    85620

    用什么策略把你的 JavaScript 迁移到 TypeScript

    我们仅从 JavaScript 文件开始，然后将越来越多的文件切换到 TypeScript。 我们可以继续使用普通的 JavaScript，并通过 JSDoc 注释添加类型信息，直到全部完成为止。...-565020e49c88) 策略2：将类型信息添加到纯 JavaScript 文件 这个方法的工作方式如下： 我们将继续使用当前的构建架构。...我们运行 TypeScript 编译器，但仅作为类型检查器（编译器选项 --noEmit）实用。 通过 JSDoc 注释（请参见下面的示例）和类型定义文件添加类型信息。...现在我们甚至可以生成类型文件（文件扩展名为 .d.ts）。...以下是通过 JSDoc 注释为普通 JavaScript 指定静态类型的方式： /** * @param {number} x - A number param.

    96710

    TypeScript 5.3

    导入属性 TypeScript 5.3支持导入属性提案的最新更新。 导入属性的一个用例是向运行库提供有关模块预期格式的信息。...通常这些都是不必要的比较，但您可能更喜欢它作为一种风格，或者避免围绕JavaScript真实性的某些问题。 无论如何，以前的TypeScript在执行收缩时无法识别这样的表单。...首选设置 type 自动导入 以前，当TypeScript为类型位置中的内容生成自动导入时，它会根据您的设置添加type修饰符。...通过跳过JSDoc解析进行优化 当通过tsc运行TypeScript时，编译器现在将避免解析JSDoc。...因为不是每个使用TypeScript的工具都需要存储JSDoc（例如typescript-eslint和Prettier），所以这种解析策略已经作为API本身的一部分出现。

    87910

    JSDoc 真能取代 TypeScript？

    我们总得先了解下 JSDoc： 可能大家认为的 JSDoc 是这个东西： 在代码的注释上加上类型的标识，然后通过 jsdoc 命令行工具，就可以直接生成文档。...比如这样的文档： 确实，这个是 JSDoc 最初的含义。 但我们说的 JSDoc 并不是这个，而是 TS 基于 JSDoc 语法实现的，在注释里给代码添加类型的语法。...然后安装 typescript： npm install --save-dev typescript 创建 tsconfig.json 文件： npx tsc --init 生成的 tscconfig.json...然后我们开启 dts： 再编译： npx tsc 可以看到同样能产出 d.ts 类型声明文件： 而这时候产物的 JS 代码和源码差别不大： 因为本来 JSDoc 就是在注释里的，类型检查也好、生成...而且这样也能利用 ts 的类型提示和检查的能力。 所以很多人就说 svelte 抛弃了 ts。 这叫抛弃么？ 并不是，JSDoc 只是另一种使用 ts 的方式而已。

    83330

    我们如何为 JavaScript 客户端减半模块化 AWS SDK 的发布规模

    为了帮助客户，服务船提供了广泛的服务和运营文档。我们在 JSDoc 评论中添加此文档。在我们的 TSConfig 设置中，我们在每个分发中都发货了多余的注释。...复制代码 Bash 我们从*.d.ts文件中删除了注释 为了支持使用旧版本的类型脚本的客户，我们使用 downlevel-dts 将具有新类型脚本功能的代码转换为使用等效旧功能的代码的下级类型。...此功能在下级类型中添加重复注释，从而增加发布规模。...复制代码 Bash 因此，使用 4.0 以上的 TypeScript 版本的客户不会在其 IDE 中看到 JSDoc 评论，尽管下级类型将起作用。...为了确保我们防止腹胀偷偷溜回来， 我们计划添加 CI 来检查发布大小。 我们还没有缩小实际源代码的大小。例如，API 呼叫的通用功能 将使源代码的大小减少 ±0.5%。

    2.6K20

    不需要TypeScript，JS+JSDoc够了？大佬说我想多了

    其次，这两者并不冲突，我个人在写 TypeScript 的时候也会写对应的 JSDoc，因为 TypeScript 的类型没法有更多的注释和描述。...TypeScript 生态更繁荣，对于普通开发者和普通的项目而言，使用 JSDoc 的开发和维护成本可能会比 TypeScript 更高。...李振：理论上也是可行的，但与 TypeScript 相比，它仍然存在一些限制： 静态类型检查的完整性：JSDoc 注释是基于注释的方式，而不是直接嵌入到语言中，因此它的类型检查可能不如 TypeScript...工具支持的差异：尽管一些工具和编辑器可以利用 JSDoc 注释进行类型检查，但与 TypeScript 相比，它们的功能和智能感知可能有所限制。...而使用 JavaScript + JSDoc 可能需要更多的手动工作来编写和维护类型注释。

    85910

    如何查看jsplumb.js的API文档(YUIdoc的基本使用)

    jsdoc风格的注释语句转换成静态网站式的离线文档，所以你可以通过定制模板来为最终生成的文档增加不同的主题样式。...jsdoc风格通常都会有IDE插件直接生成（vscode和sublime里肯定是有的，因为我自己天天用），最常见的是函数声明注释，YUIdoc中可以识别的所有语法可以查看官方提供的【YUIdoc支持的注释语法...】： //jsdoc风格的注释 /** * My method description....，例如你的工程是基于Typescript开发的，就可以使用yuidoc ....如果你开发的是一个工具库，需要生成完备的API文档，为了不影响源码阅读和开发，可以像jsplumb.js那样将注释语句单独写在一个文件中，因为是一个自动化工具，也没什么太多可讲的，有需要的朋友直接浏览一下官网就可以很容易地使用了

    2.4K00

    Airbnb 是如何从 JavaScript 迁移到 TypeScript 的？

    可以使用 jscodeshift、TypeScript API、字符串替换或其它 AST 修改工具来进行代码转换。 在每一个步骤之后，我们会检查 Git 历史中是否有任何更改并提交它们。...`args: ${arguments}`); return tsrif * dnoces;} ts-migrate 在上面的示例中做了 3 个转换： 反转了所有标识符 first -> tsrif 向函数声明添加了类型...jscodeshift 是一个使用 recast 包将抽象语法树（AST）转换回字符串的工具。通过使用 toSource() 函数，我们可以直接更新文件的源代码。...下一类插件是基于 TypeScript AST 的插件。...我们没有使用这个注释，因为它之前不支持.ts/.tsx 文件，但它也可以在迁移过程中成为一个很好的中间阶段助手。 TypeScript 的 3.9 版本引入了 @ts-expect-error 注释。

    2.3K20

    TypeScript 之父简介：TS Anders Hejlsberg: Introducing TypeScript参考资料TypeScript入门指南（JavaScript的超集)

    核心TypeScript编译器 语法分析器（Parser）： 以一系列原文件开始, 根据语言的语法, 生成抽象语法树（AST） 联合器（Binder）： 使用一个Symbol将针对相同结构的声明联合在一起...语法分析器（Parser）生成抽象语法树（AST）Node. 这些仅为用户输出的抽象表现，以树的形式。...一个SourceFile对象表示一个给定文件的AST并且带有一些额外的信息如文件名及源文件内容。 然后，联合器（Binder）处理AST节点，结合并生成Symbols。...生成SourceFile（还带有它的Symbols们）是通过调用createSourceFile API。...任何出现在这行之后的注释都属于下一个令牌。源文件的第一个令牌拥有所有的初始琐碎内容，并且最后面的一系列琐碎内容会添加到end-of-file令牌上。 对于大多数普通用户，注释是“有趣的”琐碎内容。

    2.5K20

    TypeScript是如何工作的

    相信大家对于如何在项目中使用 TypeScript 已经轻车熟路，本文就来探讨简单探讨一下 TypeScript 是如何工作的，以及有哪些工具帮助它实现了这个目标。...； 绑定器遍历 AST 语法树，生成一系列 Symbol，并将这些 Symbol 连接到对应的节点上； 检查器再次扫描 AST，检查类型，并将错误收集起来； 发射器根据 AST 生成 JavaScript...一个源文件也是一个 Node —— SourceFile，它是 AST 的根节点。 关于如何从源码生成 AST，以及从 AST 生成最终代码，相关理论很多，本文也不再赘述。...通常用 JS/TS 写成，可以获取到 VSCode API，因此可以监听 VSCode 传过来的事件，或者向 VSCode 发送通知。 语言服务器。...由于 babel 自身并不具备打包功能，所以直接在命令行中调用 babel 命令的用处不大，本节主要讨论如何在 webpack 中使用 babel 处理 typescript。

    7.1K30
    点击加载更多

    相关资讯

    热门标签

    更多标签

    活动推荐

      运营活动

      活动名称
      广告关闭

      腾讯云开发者

      扫码关注腾讯云开发者

      扫码关注腾讯云开发者

      领取腾讯云代金券

      热门产品

      热门推荐

      更多推荐

      Copyright © 2013 - 2026 Tencent Cloud. All Rights Reserved. 腾讯云 版权所有

      深圳市腾讯计算机系统有限公司 ICP备案/许可证号：粤B2-20090059 粤公网安备44030502008569号

      腾讯云计算（北京）有限责任公司 京ICP证150476号 | 京ICP备11018762号

      领券