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

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

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

1、JavaScript

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

模板

  •  ()

  •  ()

  •  ()

  •  ()

构建工具

其它工具

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

2、API

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

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

3、CSS / Style Guide

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

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

本文作者:佚名

来源:51CTO

转载地址:http://xuvxl.baihongyu.com/

你可能感兴趣的文章
个人使用unity3d过程中遇到的一些小问题集合之有时候在场景中创建光源会有一条虚线...
查看>>
POJ2774:Long Long Message——题解
查看>>
2018-2019 20165226 网络对抗 Exp1 PC平台逆向破解
查看>>
javascript作用域与预解析
查看>>
unity 代码有调整,重新导出 iOS 最烦的就是 覆盖导出后项目不能打开
查看>>
C# 中的拓展方法,以StringBuilder加上IndexOf方法举例
查看>>
[转载]部署Office Web Apps Server并配置其与SharePoint 2013的集成
查看>>
第41件事 创新设计的4种方法
查看>>
python学习===计算字符串中子串出现的次数。
查看>>
页面在谷歌浏览器和IE浏览器顶部多出空白行,火狐显示正常
查看>>
CSS子元素设置margin-top作用于父容器?
查看>>
VS Code
查看>>
做了6年开发,工资涨不上去,怎么办?
查看>>
微信5.2
查看>>
C++运算符重载笔记
查看>>
Android中数据库和安装包分离
查看>>
Android调用系统功能
查看>>
关于chorme 通知功能
查看>>
9-1迭代器
查看>>
new , delete常见用法和与malloc,free比较
查看>>