apidoc的安装和使用

背景

基于代码中注释部生成接口文档，apidoc

安装和使用

1： 安装nodejs
下载最近版本：
wget http://nodejs.org/dist/v7.2.0/node-v7.2.0.tar.gz
tar -xvf node-v7.2.0.tar.gz
cd进入到该解压的文件夹中
./configure –prefix=/usr/local/nodejs
make && make install
期间如果提示权限不足，加上sudo即可。
2：安装apidoc
/usr/local/nodejs/bin/npm install apidoc -g

安装失败可能是由于权限不足，重新加上sudo进行安装：
sudo /usr/local/nodejs/bin/npm install apidoc -g

若提示“/usr/bin/env: node: No such file or directory”
ln -s /usr/local/nodejs/bin/node /usr/bin/node
3：生成对应的接口文档
采用下面的命令：

/usr/local/nodejs/bin/apidoc -i input/your_file/ -o output/your_file/

其中input/your_file放置的是事先按照apidoc格式编写好的js文件，output/your_file则指定了生成的html的位置。
参考：
https://github.com/apidoc/apidoc
http://apidocjs.com/