博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
给 Web 开发人员推荐的文档生成工具
阅读量:6832 次
发布时间:2019-06-26

本文共 741 字,大约阅读时间需要 2 分钟。

hot3.png

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

1、JavaScript

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

模板

  •  ()

  •  ()

  •  ()

  •  ()

构建工具

其它工具

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

113856_SRWq_2896879.png

2、API

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

115247_P2sw_2896879.png

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

3、CSS / Style Guide

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

142420_jTkD_2896879.png

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

转载于:https://my.oschina.net/editorial-story/blog/1541328

你可能感兴趣的文章
sublime Text 3实用功能和常用快捷键收集
查看>>
python代码规范与标准库参考
查看>>
VMware Workstation 安装Red Hat 遇到的问题
查看>>
什么是javascript(一)
查看>>
JAVA入门到精通-第22/23讲-容器、集合类
查看>>
励志写一篇有味道的博文------json
查看>>
oracle赋权
查看>>
c异或加密与解密
查看>>
【转载】ESFramework 平台下可复用的Tcp通信层实现
查看>>
python lib
查看>>
分布式学习资料-专著列表
查看>>
9.配置postfix空客户端
查看>>
计数排序详解以及java实现
查看>>
HTML5介绍
查看>>
图片的title属性和alt属性的区别
查看>>
iOS社会化分享(干货)
查看>>
第八章实验报告
查看>>
使用 gzexe 快速加密解密文件内容
查看>>
java jvm学习笔记十(策略和保护域)
查看>>
Linux(CentOS)挂载移动硬盘
查看>>