Skip to main content
 Web开发网 » 站长学院 » 浏览器插件

达内推荐:Web 程序员好使的文档生成工具!

2021年10月08日5830百度已收录

  1、JavaScript

  JSDoc 3

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

  (1)模板

  jaguarjs-jsdoc

  DocStrap

  jsdoc3Template

  minami

  docdash

  tui-jsdoc-tempplate

  (2)构建工具

  JSDoc Grunt plugin

  JSDoc Gulp plugin

  (3)ESDoc

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

  2、API

  (1)apiDoc

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

  (2)GraphQL Voyager

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

  3、CSS / Style Guide

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

  (2)React Styleguidist

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

评论列表暂无评论
发表评论
微信