作者: zyl910 一.工具比较 为了让前端JavaScript程序更具可维护性,更利于团队开发,文档非常重要.此时便需要使用自动化文档工具了. 我对比了各种JavaScript自动化文档工具,发现JSDuck最适合我.它的优点有-- 生成文档的易读性高,界面美观. 文档注释的语法简单,功能丰富,能比较随意的编写文档注释. 对于 构造函数.闭包.极简主义 这3种方法定义的类,均能正确识别.生成文档. 提供了打包好的exe,可直接在Windows下使用,不用安装 ruby 环境.且其文件小,只有…

本文翻译自How to Write Doc Comments for the Javadoc Tool,但是精简了一些私以为不重要的东西 本文不讨论如何使用javadoc工具自动生成文档的方法,而是主要探讨应该如何去写文档注释 业余时间整理,难免有遗漏或错误,如有发现欢迎指正 转载请注明 文档注释概览 “文档注释”(Java Doc Comments)是专门为了用javadoc工具自动生成文档而写的注释,它是一种带有特殊功能的注释. 文档注释与一般注释的最大区别在于起始符号是/**而不是/*或/…

Sandcastle是微软官方的文档生成工具,NDoc开发停止后,这个貌似也是唯一的一个这方面的工具.它从dll文件及其xml注释文件能够 生成完整的帮助文档,支持多种生成格式(Helpe1x:chm, Helper2x:Hxs, Website,HelperView),结合新发布的Sandcastle Help File Builder可视化工具,整个生成过程十分简单,而且SHFB工具看起来很强大,不仅能够直接配置生成文档的各个属性,而且还支持很灵活的扩展设置,为 我们提供完美的.NET类库文…

最近安装了API文档工具swagger,因为Github上已有详细安装教程,且安装过程中没有碰到大的阻碍,所以此文仅对这次安装做一份大致记录 相关网站 Swagger 官方地址: http://swagger.wordnik.com Github安装详解[springmvc集成swagger]: https://github.com/rlogiacco/swagger-springmvc 网上安装教程[可配合Github安装教程使用]: http://www.jianshu.com/p/5cfb…

1. 引言 各位在开发的过程中肯定遇到过被接口文档折磨的经历,由于 RESTful 接口的轻量化以及低耦合性,我们在修改接口后文档更新不及时,导致接口的调用方(无论是前端还是后端)经常抱怨接口与文档不一致.程序员的特点是特别不喜欢写文档,但是又同时特别不喜欢别人不写文档.所以 API 文档工具这时就应运而生了,本篇文章我们将会介绍 API 文档工具 Swagger2 . 2. 快速上手 既然 Swagger2 是一个 API 文档工具,我们就在代码中看一下这个文档工具在 Spring Boot…

文档工具 LEARN HTML = 教程 HTML REFERENCE = 字典 HTML + CSS + JAVASCRIPT = DYNAMIC  HTML 推荐浏览器: Chrome浏览器(有丰富有利于开发者分析的工具) 善变的网页 永远不要相信网页的东西:因为你可以更改浏览器的内存从而改变页面显示内容: 根据意义记忆标签名: div = divide p = paragraph ul = unordered list i = italic b = bold hr = horizontal…

ShowDoc,APIDoc,可道云API,语雀-适合IT企业的文档工具 一.ShowDoc官方文档及说明 1.1 它可以用来做什么 1.2 它都有些什么功能 1.3 使用在线的ShowDoc 1.4 Docker方式安装 二.APIDoc 详解 api接口文档生成 2.1 安装apidoc 2.2 配置(apidoc.json) 三.可道云API 四.语雀 一.ShowDoc官方文档及说明 ShowDoc就是一个非常适合IT团队的在线文档分享工具,它可以加快团队之间沟通的效率. ShowDoc…

工具开源地址 swagger2 : https://swagger.io/ smart-doc: https://www.oschina.net/p/smart-doc  国产 两者的比较 swagger2 和 smart-doc 两个开源工具 都可以 使用jar包 生成 api 文档. 相同点: 这个两个工具 都可以 自动 扫描 有 @Controller 注解的 类 并生成  相应的 api 接口文档.都可以生成 静态网页,提供在线api html 页面的访问. 区别: 1.swagger2…

参考资料: http://my.oschina.net/wangxuanyihaha/blog/188909   LDoc介绍:     LDoc是一个Lua的文档生成工具,过去,比较常用的Lua生成文档的工具是LuaDoc,可惜作者自从2008年之后就再也没有发布过新的版本了,说明作者基本上已经放弃维护了.而LDoc则是一直在更新中,所以现在选择LDoc来给Lua生成文档是更好的选择,LDoc的Github主页. LDoc的一个优点就是,它的目的是为了和LuaDoc兼容并且拓展LuaDoc的功…

一个非侵入的api编译.收集.Rest文档生成工具.工具通过分析代码和注释,获取文档信息,生成RestDoc文档 前言 程序员一直以来都有一个烦恼,只想写代码,不想写文档.代码就表达了我的思想和灵魂. Python提出了一个方案,叫docstring,来试图解决这个问题.即编写代码,同时也能写出文档,保持代码和文档的一致.docstring说白了就是一堆代码中的注释.Python的docstring可以通过help函数直接输出一份有格式的文档,本工具的思想与此类似. 代码即文档 Apigcc是一…