用开源apidoc编写php接口文档,也可以编写其他语言apidoc安装使用

网址: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之前,他会自动读取“注释”中的内容,很强大。









评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值