ShowDoc(API文档编辑工具)下载 2.4.0 官方版

　　ShowDoc可以帮助用户编辑API文档，让用户在编辑源代码的时候可以更好对代码做标注，可以让别人知道你编辑的代码是什么意思，适合专业的开发团队使用，当你在编辑新软件或者是开发新项目的时候就可以将本软件安装到你的开发环境，在编辑代码的时候就可以及时编辑API，方便其他用户找到函数或者是调用类似的API；ShowDoc提供多种部署方式，可以选择好动安装，可以选择自动脚本安装，详细的安装方式可以查看官方提供的教程！

软件功能

　　1、ShowDoc提供更好的编辑方式，帮助用户在设计API文档的时候提供更方便的操作

　　2、可以手动编辑API文档，可以从代码生成API文档

　　3、现在很多程序都会制作API文档

　　4、通过查看API文档就可以知道软件开发的结构以及相关模块的介绍

　　5、让编程人员可以知道该项目详细的编程方式

　　6、当你需要编辑API文档的时候就可以选择ShowDoc

　　7、提供丰富的编辑组件，支持composer.json，支持.gitignore

　　8、可以将所有编辑组件添加到你的开发环境

　　9、可以在直接从你的代码文件找到可以制作为API文档的内容

　　10、提供verifyCode.php、jquery.zclip等多种调试组件

软件特色

　　1、API文档在很多场合都可以使用，支持对新开发项目制作API文档

　　2、支持对一些的比较复杂的模块设计介绍类型的API文档

　　3、也可以对数据字典编辑，方便开发人员查看数据库结构

　　4、ShowDoc软件提供良好的markdown编辑器

　　5、输入的API以及文字内容都可以在编辑器显示

　　6、可以让客户知道你开发的详细方案

　　7、可以让编程人员一眼看懂开发逻辑

　　8、相关的函数以及代码都可以通过ShowDoc世界编辑

　　9、适合在开发大型项目以及团队项目的时候制作API文档

安装方法

　　1、自动脚本安装

　　官方强烈推荐使用自动脚本安装showdoc。因为使用自动脚本可以省去很多安装环境依赖的麻烦，你只需在命令行下执行命令即可。自动脚本安装教程：https://www.showdoc.cc/help?page_id=828455960655160 。假如自动脚本安装失败，你可以考虑手动安装。

　　2、手动安装

　　A:docker安装

　　如果你不想通过自动脚本，但是又想用docker来自定义安装，则可以参考教程https://www.showdoc.cc/help?page_id=65610

　　B:php安装

　　如果你不想使用自动脚本或者docker安装，showwdoc需要PHP5.3及以上版本，你可以参考这里安装环境http://www.showdoc.cc/php 。安装完PHP环境后，下载代码：https://github.com/star7th/showdoc 。下载完毕后将代码放到PHP的web目录。一般来讲，不同系统的web目录路径不太一样。请根据你安装的环境来定。

　　C：Windows服务器

　　在php.ini里面把”extension=php_sqlite.dll”和”extension=php_pdo_sqlite.dll”启用以便开启对SQlite的支持；也启用php_mbstring.dll；Linux服务器则不需要此操作。

使用方法

　　1、提供在线功能，你可以到官方网站注册一个账号再使用

　　2、提示建立新项目的方式，你可以输入项目名字以及输入项目描述

　　3、假如你的个性域名设置为abc,则你的项目地址为www.showdoc.cc/abc

　　4、密码为空时，所有人均可以通过项目地址访问。设置密码后，只有项目成员和输入密码的人能访问

　　5、进入编辑的界面，可以在这里设计当前的API文档，可以在下方输入新内容

　　6、点击插入API接口模板，这里是编辑的界面，你可以查看相关的模板内容

　　7、由于使用markdown编辑器，所以输入的代码都可以及时在软件上显示

　　8、插入数据字典模板，相关的内容就在这里显示

　　9、有两个工具可以选择，支持JSON转参数表格、JSON格式化

　　10、编辑工具都在这里显示，例如可以添加引用链接，也可以添加图片，也可以插入链接

　　11、这里的序号决定页面在项目左侧菜单中的顺序，在根目录或者当前目录下，每个页面按照序号从小到大排序。在没有填写序号的情况下，showdoc将默认补上序号99，你也可以手动设置为更小的数字，比如98。那么，该页面将比其他99的页面都要靠前。以此类推

　　12、在右上方也可以查看软件的帮助，可以了解编辑格式以及编辑器的语法

使用说明

　　对于写API文档这件事，虽然说文本编辑软件或者接口管理软件能在某种程度上提高我们的效率，但我们依然可以试图借助技术的力量，更自动化地生成API文档，释放自己的生产力。

　　为此，showdoc官方提供了一种自动化解决方案。在代码里编写特定格式的程序注释，然后showdoc通过读取这些注释来自动生成文档。由于这种方式不跟特定的语言耦合，因此它的使用范围相当广泛，可用支持c++、java、php、node、python等等常见的主流语言。

　　采用这种方式，尽管我们在第一次填写注释的时候可能会有些繁琐，但是它后期带来的可维护性是非常高的。代码变动后，不需要再额外登录showdoc，直接在代码里修改注释即可。同时自动化的脚本也可以加入持续集成或者某些自动化工程里，让“写API文档”这件事如”单元测试”般纳入工程工作流里面。

　　windows下使用指引

　　windows无法直接运行sh脚本，需要额外下载软件。

　　推荐下载git for windows：https://git-scm.com/download/win 下载后直接双击安装即可。

　　如果从官网下载比较慢，可用考虑下载由第三方开发者维护的国内版(showdoc官方不保证其长期稳定)：

　　https://npm.taobao.org/mirrors/git-for-windows/v2.17.0.windows.1/Git-2.17.0-64-bit.exe

　　以上软件是基础环境。安装好了后，还需要下载showdoc官方脚本：https://www.showdoc.cc/script/showdoc_api.sh

　　下载后，将showdoc_api.sh放在你的项目目录下。右击，选择编辑。

　　脚本内容的前面有两个变量，api_key 和 api_token ，这个需要用户自行填写。关于这两个变量的取值，请登录showdoc，进入某个项目的设置，点击开放API，便可以看到说明。showdoc_api.sh生成的文档会放进你填写的这个项目里。除了api_key 和 api_token ，还有一个url变量。如果是使用www.showdoc.cc ，则不需要修改。如果是使用开源版showdoc，则需要将地址改为http://xx.com/server/index.php?s=/api/open/fromComments ，其中，别忘记了url里含server目录。

　　填写完毕，保存。然后直接双击运行，脚本会自动递归扫描本目录和子目录的所有文本代码文件，并生成API文档。

　　为了方便测试，官方还提供了一个例子。请下载：

　　https://www.showdoc.cc/script/api_demo.test

　　下载后，把api_demo.test文件放在showdoc_api.sh所在的目录或者子目录下。运行的时候它便会生成文档到你指定的项目地址中。

　　如果你想参考官方demo是怎么写的，可用鼠标右击api_demo.test，选择编辑。仿照此种写法，在你的项目中插入类似的注释，也能达到自动生成文档的效果。详细语法会在文章后面部分说明。

　　如果你想应用到其他项目，可以把showdoc_api.sh复制一份到其他项目中。使用方法和前面一样。