成都web前端培训:给Web程序员推荐的文档生成工

时间:2017-09-26 10:44来源:成都达内web前端培训 作者:web前端 点击:

  成都web前端培训:给Web 程序员推荐的文档生成工具!

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

  1、JavaScript

  JSDoc 3

  https://www.oschina.net/p/jsdoc

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

  模板

  jaguarjs-jsdoc:https://github.com/davidshimjs/jaguarjs-jsdoc

  DocStrap:https://github.com/docstrap/docstrap

  jsdoc3Template:https://github.com/DBCDK/jsdoc3Template

  minami:https://github.com/Nijikokun/minami

  docdash:https://github.com/clenemt/docdash

  tui-jsdoc-template:https://github.com/nhnent/tui.jsdoc-template

  构建工具

  JSDoc Grunt plugin:https://github.com/krampstudio/grunt-jsdoc

  JSDoc Gulp plugin:https://github.com/mlucool/gulp-jsdoc3

  其他工具

  jsdoc-to-markdown:https://github.com/jsdoc2md/jsdoc-to-markdown

  Integrating GitBook with JSDoc:https://medium.com/@kevinast/integrate-gitbook-jsdoc-974be8df6fb3

  ESDoc

  https://esdoc.org/

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

  Demo

  成都web前端培训

  2、API

  apiDoc

  http://apidocjs.com/

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

  Demo

  成都web前端培训

  GraphQL Voyager

  https://apis.guru/graphql-voyager/

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

  成都web前端培训

  3、CSS / Style Guide

  Knyle Style Sheets(KSS)

  http://warpspire.com/kss

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

  成都web前端培训

  React Styleguidist

  https://react-styleguidist.js.org/

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

  Demo

  成都web前端培训

  成都it培训哪家好,当然是成都达内培训,成都达内是一家专业的程序员培训机构,专注于网络营销课程,成都ui培训,成都软件测试培训,成都php培训,成都java培训,成都安卓培训,成都会计实操培训,web前端开发,成都网络营销培训,成都it培训,成都编程培训,成都程序员培训等IT培训,专业的成都软件培训机构,专业师资授课,真实项目实战、零首付、低押金、名企就业,达内培训怎么样,成都web前端培训机构www.cdtedu.com/pxkc/web/

(责任编辑:成都达内)

CopyRight © 2002-2016 成都达内科技职业技能培训学校 (www.cdtedu.com) 版权所有 成都达内 川公网安备 51019002000307号 网站地图