自己实现接口文档生成工具（接口文档 工具）

本篇文章给大家谈谈自己实现接口文档生成工具，以及接口文档 工具对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。 今天给各位分享自己实现接口文档生成工具的知识，其中也会对接口文档 工具进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、php接口文档生成工具phpdoctor怎么用
• 2、有没有从 json 生成接口文档的工具
• 3、websocket 可不可以用什么工具自动生成接口文档

php接口文档生成工具phpdoctor怎么用

一、phpxref↑
PHPXref是一个易用级的PHP项目文档生成工具，它生成Html的文档—-结构清晰、明了。PHPXref可以方便的在不同平台下（Linux with Perl，Win32 with EXE）帮助你生成某一目录下所有php文件的“资源”索引文档。这些“资源”，包括：Class（类）、Function（函数）、Variable（变量）、Constant（常量）…..。PHPXref给我们列出了这些资源的定义与引用的详细情况。我们可以很方便地找到某一个函数（变量）在何处被定义，在何处被调用（引用）。 这里以Wordpress为例，它能Wordpress中所有的函数、变量、常量等分类记录，生成一个HTML网页列表，你可以轻松地在这个列表中找到某个函数在什么位置被定义，在什么位置被引用。如果你是Wordpress插件开发者或者想学习研究Wordpress的人，项目文档的作用比较明显。 PHPXref官方有个已经制作好的Wordpress的分析文档：http://phpxref.com/xref/wordpress/，此外，PHPXref还制作了多种PHP程序的分析文档，有兴趣的可以Google站内搜索一下。 PHPXref的主要功能包括：
文件管理。无论要找什么文件，用它能很快地搜索到，如果你的文件中有符合语法规则的注释，PHPXref还能将它列在文件名的旁边，更容易了解这个文件的功能用途，也不用为了找一个文件翻遍整个文件夹，打开每个文件查找注释了。
函数、变量、常量、类管理。Wordpress内置了多种功能强大的函数、类，无论是字符处理还是远程URL读取等都有现成的函数，但我们往往 不知道这个函数能在Wordpress里面找到，现在容易多了，搜索一下就找到了，如果在开发过程中遇到某个Wordpress函数，不知道它是干什么用 的，这时候就得找到这个函数在哪里定义的，可是Wordpress里面上百个文件上哪找去？还是用PHPXref好了。
文件包含管理。Wordpress中需要很多 include，require包含别的文件，但偶尔也会遇到重复包含导致出错，虽然require_once可以解决，但我们也最好要了解某个脚本包含 了哪些文件，要调用这个文件时也心中有数。PHPXref提供了每个文件的包含文件列表和被包含的文件。
源代码高亮。这个功能也是比较实用的，但在实际测试中偶尔会出错。
出色的关联功能。在浏览源代码时，将鼠标指到某个函数名，就会在鼠标旁边出现函数的定义页面，以及被使用次数，此外，还对使用较多的变量名，也是可以直接有个页面显示所有的关于这个变量的使用情况。
简介下windows下其使用过程：
1、下载：官方网站：phpxref官方sf网站
2、使用（以下载windows版本为例）：通过以上下载你将得phpxref-0.7-win32.zip压缩包。
步骤一：解压phpxref-0.7-win32.zip。进入phpxref-0.7-win32（注：不用安装的，所以你不用习惯性的去点击.exe可执行文件），你将看一个名为：source的目录—它很关键；
步骤二：复制你的项目文件到上面提到的source目录。
步骤三：双击phpxref.exe；
步骤四：如果项目比较大，请耐心等待数秒钟。
步骤五：进入和source目录同级的output目录，你将看到一些东西。呵呵，双击index.html开始观看你的项目文档,去尝试吧，它能告诉你的很多哦。
PHPXref还提供了在Linux下生成文档的版本，但我很少用，也没有去测试了，我想更多数人需要的还是Win系统下的，如果有需要，把Win下生成的文档可以搬到服务器上去供大家访问。但PHPxref生成的文档实在太大了，一个1.2MB的Wordpress(压缩包)，解压后再生成文档，居然要80多 MB的位置！压缩完后也需要接近20MB。 除了用PHPXref来生成已有的Wordpress或其他PHP示范程序（如Discuz）进行学习外，用PHPXref来生成自己制作的PHP 程序，进行检验错误或者是整理代码资源也很有用
二、PHP Doctor↑
安装php支持（若你有php环境支持，可以略去），设置环境变量path，把php 的安装路径加上，比如php 安装在d:/php5/
下载phpdoctor，可以去官网下载把下载的压缩包解压到任何地方
配置phpdoctor, phpdoctor 最基本的配置，复制一个ini文件进行就该就好
//源码路径，比如您的源码路径d:work/phptest,如下设置
source_path=“d:work/phptest”
//生成的html 文档保存路径,默认是保存在当前目录下apidocs(系统自动创建)，可以更改为其他目录，比如
d = "apidocs"或 d = "d:work/doc"
生成文档
打开你的cmd,先切换到你的phpdoctor 安装路径，然后执行下面代码
php phpdoc.php <config_file

有没有从 json 生成接口文档的工具

要生成接口文档：直接写好注释就可以用javadoc命令生成了。
要生成UML图，可以下载Eclipse的插件来生成，在Eclipse Market中搜索UML关键字然后安装即可。

websocket 可不可以用什么工具自动生成接口文档

浏览器访问web服务器,服务器的脚本是JAVA做的，JAVA脚本里访问Netty的JAVA接口不就得了，当然只是一瞬间访问了。如果是长时间访问，你得用JAVA单独做个程序访问NETTY 关于自己实现接口文档生成工具和接口文档 工具的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 自己实现接口文档生成工具的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于接口文档 工具、自己实现接口文档生成工具的信息别忘了在本站进行查找喔。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。