开发者社区> 行者武松> 正文
阿里云
为了无法计算的价值
打开APP
阿里云APP内打开

给 Web 开发人员推荐的文档生成工具

简介:
+关注继续查看

工欲善其事必先利其器,在此给 Web 开发人员推荐几款优秀的开源文档生成工具,希望能对大家有所帮助。

1、JavaScript

JSDoc 3

这是一款根据 Javascript 文件中注释信息,生成 JavaScript 应用、库、模块的 API 文档的工具。你可以使用它记录如:命名空间、类、方法、方法参数等。该项目还衍生出了许多模板和其他工具来帮助生成和自定义文档,比如:

模板

构建工具

其它工具

ESDoc

一个 JavaScript 文档生成器,按照规范编写代码注释,即可生成友好的 JavaScript 代码文档。它可以将测试代码和用户手册一并集成到文档中,支持通过插件添加自定义功能。

Demo

2、API

apiDoc

这是一款 RESTful Web API 文档生成工具,一个在注释里边编写 API 文档的小工具。有了它,只需在写源码的时候顺手写上一些简单的注释,就可以生成出漂亮的文档了。项目支持大部分主流语言,注释维护起来也比较方便,不需要额外再维护一份文档。

Demo

GraphQL Voyager

这是一款将任意 GraphQL API 表示为交互式图形的工具,可以直观地浏览 GraphQL API 。在设计或讨论数据模型时,非常有用。

3、CSS / Style Guide

Knyle Style Sheets(KSS)

KSS 既是一份文档规格说明,也是一种编写样式指南的格式,旨在帮助开发者自动化地创建可读、可解析的样式指南。它为团队编写具有可维护性、可文档化的 CSS 提供一套方法。

React Styleguidist

顾名思义,这是一款 React 样式指南生成器,可与你的团队分享在线样式指南。它列出组件支持类型,并展示基于 Markdown 文件的实时、可编辑的使用示例。

Demo



本文作者:佚名

来源:51CTO

版权声明:本文内容由阿里云实名注册用户自发贡献,版权归原作者所有,阿里云开发者社区不拥有其著作权,亦不承担相应法律责任。具体规则请查看《阿里云开发者社区用户服务协议》和《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容,填写侵权投诉表单进行举报,一经查实,本社区将立刻删除涉嫌侵权内容。

相关文章
Desmos-可能是迄今为止最好用的免费Web端数学图像绘制工具
Desmos是一个在线绘制函数图像的网站,通过表达式,Desmos可以轻松的帮助你绘制你想绘制的图像,精准且方便。
0 0
学习python web 需要的掌握技能、框架、必备工具、
学习python web 需要的掌握技能、框架、必备工具、
0 0
python【模块】Selenium 自动化测试Web 工具(3)
python【模块】Selenium 自动化测试Web 工具(3)
0 0
python【模块】Selenium 自动化测试Web 工具(2)
python【模块】Selenium 自动化测试Web 工具(2)
0 0
python【模块】Selenium 自动化测试Web 工具(1)
python【模块】Selenium 自动化测试Web 工具(1)
0 0
2022-渗透测试-web目录爆破-常用的三个工具
2022-渗透测试-web目录爆破-常用的三个工具
0 0
【软件测试】使用selenium工具对Web聊天室项目进行UI自动化测试
在用户注册页面,用户输入用户名,密码,昵称,图像文件(可以不上传)即可完成注册,但是如果昵称或者用户名被注册过了,就会显示账号或昵称已经存在
0 0
【JavaWeb】Tomact部署Web项目及Maven工具的使用
Tomcat是一个web服务器,用于提供web(http,https)服务端程序,它是一个基于Java实现的一个开源且免费,也被广泛使用的HTTP服务器
0 0
dirsearch web网站目录扫描工具详解
作者主页:https://www.couragesteak.com/
0 0
使用 ABAP 开发的一个基于 Web Socket 的小工具,能提高程序员日常工作效率
程序员区别于其他岗位的一个优势是,我们可以充分利用自己掌握的编程语言,将平日一些琐碎的,重复的日常工作,通过代码来实现自动化,从而省下更多的时间来投入到技术含量更高的工作中,提高工作效率。
0 0
+关注
行者武松
杀人者,打虎武松也。
文章
问答
文章排行榜
最热
最新
相关电子书
更多
边缘安全,让Web加速有保障
立即下载
使用CNFS搭建弹性Web服务
立即下载
WEB框架0day漏洞的发掘及分析经验分享
立即下载