ShowDoc是一个非常适合IT团队的在线API文档、技术文档工具,可以帮助用户编辑API文档,让用户在编辑源代码的时候可以更好对代码做标注,可以让别人知道你编辑的代码是什么意思,适合专业的开发团队使用,同时还支持对这些代码进行高亮设置,让我们对一些代码很快就能找出来,支持对文档进行比对,找出这些文档的差异化并进行修改。
软件功能
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服务器则不需要此操作。
更新日志
增加快速复制分享链接的功能
为了加强多人多团队情形下的项目协作,正式推出团队管理功能
为了应对复杂项目内容的分类需求,showdoc在原来目录支持的基础上增加一层子目录,支持到了三级目录。用户在新建目录的时候选择父层目录为二级目录即可。