JavaScript的文档生成器

简介: 大多数 IDE 包含主语言的文档生成器。因为 JavaScript 没有官方 IDE,所以过去文档要么手动生成,要么借用其他语言的文档生成器生成。不过,目前已出现了一些面向 JavaScript 的文档生成器。

👦个人简介:张清悠,字澄澈,号寻梦客,爱好旅行、运动,主攻前端方向技术研发,副攻Unity 3D、C++、Python人工智能等
📝个人寄语:学会不为过程的缓慢而焦虑,即使暂时未能如你所愿,但只要你在努力,你就在不断成长!
🙏个人公众号:清悠小猿(海量源码尽在其中,欢迎关注)

一、文档生成器

大多数 IDE 包含主语言的文档生成器。因为 JavaScript 没有官方 IDE,所以过去文档要么手动生成,
要么借用其他语言的文档生成器生成。不过,目前已出现了一些面向 JavaScript 的文档生成器。

1.1 ESDoc

ESDoc 能够为 JavaScript 代码生成非常高级的文档页面,包括从文档页面链接到源代码的功能。
ESDoc 还有一个插件库可以扩展其功能。不过,ESDoc 要求代码必须使用 ES6 模块。

1.2 documentation.js

documentation.js 可以处理代码中的 JSDoc 注释,自动生成 HTML、Markdown 或 JSON 格式的文档。
它兼容最新版本的 ECMAScript 和所有主流构建工具,也支持 Flow 的注解。

1.3 Docco

按照其网站的描述,Docco 是“简单快捷”的文档生成器。这个工具的理念是以简单的方式生成描
述代码的 HTML 页面。Docco 在某些情况下会出问题,但它确实是生成代码文档的极简方法。

1.4 JsDoc Toolkit

JsDoc Toolkit 是早期的 JavaScript 文档生成器。它要求代码中包含 Javadoc 风格的注释,然后可以基
于这些注释生成 HTML 文件。可以使用预置的 JsDoc 模板或自己创建的模式来自定义生成的 HTML 页
面格式。JsDoc Toolkit 是个 Java 包。

1.5 YUI Doc

YUI Doc 是 YUI 的文档生成器。该生成器是用 Python 写的,因此要求安装 Python 运行时。YUI Doc
输出的 HTML 文件中集成了基于 YUI 的自动完成部件的属性和方法搜索功能。与 JsDoc 一样,YUI Doc
要求代码中包含 Javadoc 风格的注释。可以通过修改默认 HTML 模板和关联的样式表来修改默认的
HTML 输出。

1.6 AjaxDoc

AjaxDoc 的目标与前面的文档生成器稍有不同。它不会为 JavaScript 代码创建 HTML 文件,而是会
创建与.NET 语言(如 C#、Visual Basic)兼容的 XML 格式。这样就可以使用标准.NET 文档生成器来创
建 HTML 文档。AjaxDoc 要求所有文档注释的格式与.NET 语言的文档注释格式类似。AjaxDoc 是为
ASP.NET Ajax 解决方案而创建的,但也可以用于独立的项目。

总结:

本期我们分享的是JavaScript(二十三)的文档生成器
我们下期:继续分享JavaScript的文档生成器
原创不易,期待您的点赞关注与转发评论😜😜
目录
相关文章
|
3月前
|
前端开发 JavaScript 中间件
掌握JavaScript中的迭代器和生成器(下)
掌握JavaScript中的迭代器和生成器(下)
|
3月前
|
存储 JavaScript 前端开发
掌握JavaScript中的迭代器和生成器(上)
掌握JavaScript中的迭代器和生成器
|
6月前
|
XML JavaScript 前端开发
SAP UI5 本地开发如何实现 XML 和 JavaScript 代码的自动完成和嵌入式 API 文档自动显示试读版
SAP UI5 本地开发如何实现 XML 和 JavaScript 代码的自动完成和嵌入式 API 文档自动显示试读版
65 0
|
2月前
|
JavaScript 前端开发 容器
 JavaScript 遍历文档生成目录结构
 JavaScript 遍历文档生成目录结构
19 1
|
3月前
|
JavaScript 前端开发 Java
小笔记:如何使用代码注释:关于JavaScript与TypeScript 注释和文档的自动生成
小笔记:如何使用代码注释:关于JavaScript与TypeScript 注释和文档的自动生成
182 0
|
3月前
|
JSON JavaScript 前端开发
Danfo.js专题 - 附:Dnotebook(Danfo Notebook)单机资源与汉化文档
Danfo.js专题 - 附:Dnotebook(Danfo Notebook)单机资源与汉化文档
51 0
|
8月前
|
JavaScript 前端开发 API
深入解析JavaScript Generator 生成器的概念及应用场景
本文讲解了JS生成器的概念和应用场景。生成器是一个可以暂停和恢复执行的函数。利用生成器我们可以很方便地实现自定义的可迭代对象、状态机、惰性计算等,并且还能用它来简化我们的异步操作代码。
230 0
|
4月前
|
存储 JavaScript 前端开发
JavaScript DOM 操作:什么是文档碎片(Document Fragment)?有什么作用?
JavaScript DOM 操作:什么是文档碎片(Document Fragment)?有什么作用?
72 0
|
9月前
|
XML JavaScript 前端开发
|
4月前
|
前端开发 JavaScript
使用 JavaScript 和 CSS 的随机颜色生成器
使用 JavaScript 和 CSS 的随机颜色生成器
69 0