中国领先的IT技术网站
|
|

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

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

作者:佚名来源:开源中国|2017-09-22 13:58

开发者大赛路演 | 12月16日,技术创新,北京不见不散


工欲善其事必先利其器,在此给 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

【编辑推荐】

  1. iWeb峰会•北京站超燃开幕,打破边界共聚共享
  2. 外媒速递:20项Web编程提示助你快速提升技术水平
  3. Web 开发者需要知道的 12 个终端命令
  4. 外媒速递:这些工具你用过没?20款选项加持Web设计与开发
  5. 十个免费的web前端开发工具 – Envato – Medium
【责任编辑:张燕妮 TEL:(010)68476606】

点赞 0
分享:
大家都在看
猜你喜欢
24H热文
一周话题
本月最赞

读 书 +更多

软件工程:实践者的研究方法

20多年以来,《软件工程:实践者的研究方法》一书是最受学生和行业专业人员欢迎的软件工程指南。它在全面而系统、概括而清晰地介绍软件工程...

订阅51CTO邮刊

点击这里查看样刊

订阅51CTO邮刊
× 51CTO学院双十二活动