网址:http://apidocjs.com/
基本环境 node npm环境
[root@centos ~]#
[root@centos ~]# node -v
v0.10.36
[root@centos ~]# npm -v
1.4.28
[root@centos ~]#
全局安装 npm install apidoc -g
=============
生成文档必须有.json 文件和.php文件
[root@centos php]# ls
apidoc.json doc test.php
[root@centos php]#
然后直接运行命令 apidoc ,
root@centos php]# apidoc
info: Done.
然后会直接默认生成一个doc文件目录,当然可以指定一下(用i和o命令 即input和output)
doc生成格式如下
可以直接访问这个目录,或者拖放到windows1桌面
访问如下图
当然这只是初级应用,他可以引用公共头部,页脚,继承。可以自定义很多东西。
如果是php的话只把他加在function之前,他会自动读取“注释”中的内容,很强大。