许多开发者喜欢使用TypeScript,因为它具有类型检查功能。然而,这需要额外的转译步骤,可能会带来麻烦和浪费时间。本文将向您展示如何使用JSDoc来获得相同类型的控制,同时使用纯JavaScript进行最快的开发时间和更好的文档编写!
JavaScript已经巩固了其作为近年来最常用的脚本语言之一的地位。它以在Web平台上编写脚本的简易性而闻名。随着语言的发展,它从最初只是一个利用Java成功的“玩具”语言,发展成为一个用于构建不仅仅是小型脚本的完整语言。
不幸的是,这揭示了语言的缺陷。其中一些包括:
缺乏静态类型和严格的类型检查:JavaScript非常宽容,允许将参数传递给不接受它的函数,可以省略必需的值等。这在静态类型语言中是不允许的,因为会在编译时出错。这些错误会在JavaScript应用程序中出现在生产环境中。
JavaScript在扩展和维护大型代码库方面存在困难:JavaScript没有提供强大的机制来管理大型代码库,这使得随着时间的推移,项目的扩展和维护变得具有挑战性。
Typescript
2014年,微软推出了TypeScript v1.0。这改变了整个JavaScript生态系统。
TypeScript是JavaScript的超集,解决了上述问题以及更多问题。这使得它在最近的时间里越来越受欢迎。
2022年的State of Js调查显示TypeScript的使用率上升。
TypeScript 在解决了许多问题的同时,也并非没有缺点。
在本文中,我们将介绍一种非常好的 TypeScript 替代方案,名为 JSDoc,它解决了静态类型和可扩展性的问题,同时也消除了 TypeScript 在 JavaScript 生态系统中的一些缺点。
JSDoc是什么?
JSDoc是一个用于JavaScript的文档系统。它通过使用包含JSDoc语法的注释来工作。
JSDoc语法具有多种用途,包括用类型注释值,为函数指定参数和返回类型,为函数提供文档和使用信息,以及类型错误等。类似于TypeScript,这些可以被代码编辑器利用,作为指导程序员构建、使用或维护所述代码库的指南。
JSDoc VS TypeScript
JSDoc和TypeScript都解决了编写和维护纯JavaScript代码的问题。然而,它们采用了不同的方法,各有利弊。
JSDoc相对于TypeScript的优势:
灵活性和兼容性:JSDoc只是JavaScript注释,这意味着它可以添加到任何JavaScript代码库中,而不受语言版本的限制,并且不像TypeScript那样与编译器绑定。
代码注释:JSDoc不仅可以用于类型检查,还可以用于添加更多的文档,描述函数的工作原理,并生成文档网站,从而提供价值以增强代码的可维护性和理解性。
无需编译步骤:这是从TypeScript转换到JSDoc最具动力的原因之一。TypeScript需要编译将TypeScript代码转换为JavaScript,以便浏览器能够理解,而JSDoc不需要任何其他步骤&#x