JSDoc 是一种用于 JavaScript 代码文档注释的标记语言和工具。它不仅仅是一种文档编写方式,更是一种代码规范和团队协作工具。通过使用 JSDoc 注释,开发人员可以将关于函数、类、方法、参数、返回值等方面的信息嵌入到代码中,从而帮助其他开发人员更轻松地理解和使用代码。 1.2JSDoc 能够用来做什么? JSDoc 提供了以下...
使用场景:声明当前函数的this指向,在非纯函数的编程环境中,this的指向经常是编辑器无法推断的,而且对其他开发人员也不够清晰,使用@this可以清晰地告诉外界当前函数的this指向 javascript复制代码/*** @description jsdoc this 使用示例* @this Vue*/functiontestThis(){this.$alert('123')} 效果:此时调用函数时编...
介绍:JSDoc 3 是一个用于 JavaScript 的API文档生成器,类似于 Javadoc 或 phpDocumentor。可以将文档注释直接添加到源代码中。JSDoc 工具将扫描您的源代码并为您生成一个 HTML 文档网站。 说明:这里介绍的是把注释以一种类型文档的显示 做标注,不是普通的做个 文本描述。所以 JSDoc 的功能 和 typescript 的 ...
因为本来 JSDoc 就是在注释里的,类型检查也好、生成 dts 也好,都不用改动源码。 这就是 JSDoc 最大的好处:无侵入的给 JS 加上类型,拥有和 ts 一样的类型检查、类型提示、生成 dts 等功能,但却不需要编译,因为 JS 代码可以直接跑。 有同学可能会说,就声明个函数类型就和 ts 一样了? 那肯定不止这么点...
JSDoc 3 是一个用于 JavaScript 的 API 文档生成器,类似于 Javadoc 或 phpDocumentor,可以将文档注释直接添加到源代码中,JSDoc 工具将扫描您的源代码并为您生成一个 HTML 文档网站。
npm install jsdoc -g 然后输入命令 jsdoc book.js 使用jsDoc来注释代码,带来的好处就是,维护者能够很清晰的看出函数的作用和参数的类型,做到代码即文档。可以不用写那么多的注释! 在日常开发时,结合vscode的自动补全、动态提示功能,一定能让我们开发效率大大提升!
jsdoc js/demo.js 执行命令后,目录下会多出现一个 out 文件夹,里面是生成的 html 点击预览效果大概是这样子的 到这一步,js 生成文档就生成好了。 配置 通过配置文件,可以配置指定哪些文件需要生成,生成的出口等。更多配置解说可查看官方文档。https://jsdoc.zcopy.site/about-configuring-jsdoc.html ...
JSDoc 3 是一个用于 JavaScript 的 API 文档生成器,类似于 Javadoc 或 phpDocumentor,可以将文档注释直接添加到源代码中,JSDoc 工具将扫描您的源代码并为您生成一个 HTML 文档网站。
JSDoc 真能取代 TypeScript?,这几个月,想必大家都听到过一个新闻:Svelte弃用TypeScript,改用JSDoc了。TypeScript我们知道,是用来给JS加上类型的,可以实现类型提示和编译时的类型检查。
刘易成:JSDoc 只能解决一部分类型的问题,而 Type 是一个完整的类型系统。Type 生态更繁荣,对于普通开发者和普通的项目而言,使用 JSDoc 的开发和维护成本可能会比 Type 更高。 李振:理论上也是可行的,但与 Type 相比,它仍然存在一些限制: 静态类型检查的完整性:JSDoc 注释是基于注释的方式,而不是直接嵌入到语言...