phpdoc 使用(一)
最近由于业务需要,需要开发文档,并且代码注释要写的详略得当,所以干脆按照phpdoc的格式写,用它来生成文档,文档看起来貌似还不错.
1 安装phpdoc
pear channel-discover pear.phpdoc.org
pear install phpdoc/phpDocumentor
2 安装完成后,可以用 phpdoc -h
来查看phpdoc 的使用信息
user@ubuntu15:/srv$ phpdoc -h
Usage:
project:run [-t|--target[="..."]] [--cache-folder[="..."]] [-f|--filename[="..."]] [-d|--directory[="..."]] [--encoding[="..."]] [-e|--extensions[="..."]] [-i|--ignore[="..."]] [--ignore-tags[="..."]] [--hidden] [--ignore-symlinks] [-m|--markers[="..."]] [--title[="..."]] [--force] [--validate] [--visibility[="..."]] [--defaultpackagename[="..."]] [--sourcecode] [-p|--progressbar] [--template[="..."]] [--parseprivate] [--log[="..."]]
...
-d 源php文件的路径
-t 生成文档后文档的存放路径(最好为其单独创建一个文件夹)
-dn 包的名字(默认为default,最好改成项目的名字)
-dc 目录的名字(默认为default,最好改成项目的名字)
-ti 文档标题 这是首页上的大标题
-o 生成的文档的模板格式,这个应该有很多种可以选择,不过我只选择:HTML:Smarty:PHP(感觉比较美观)
3 实践下
phpdoc -d /remote/ -t ~/Documents/
在指定的目录下生成了好多文件
classes phpdoc-cache-15 phpdoc-cache-3d phpdoc-cache-60 phpdoc-cache-8b phpdoc-cache-be phpdoc-cache-e2
css phpdoc-cache-18 phpdoc-cache-41 phpdoc-cache-61 phpdoc-cache-8c phpdoc-cache-c1 phpdoc-cache-e3
extension-src phpdoc-cache-1a phpdoc-cache-42 phpdoc-cache-65 phpdoc-cache-91 phpdoc-cache-c6 phpdoc-cache-e4
files phpdoc-cache-1b phpdoc-cache-43 phpdoc-cache-66 phpdoc-cache-92 phpdoc-cache-c7 phpdoc-cache-ed
font phpdoc-cache-1c phpdoc-cache-44 phpdoc-cache-6f phpdoc-cache-9a phpdoc-cache-c8 phpdoc-cache-f0
graphs phpdoc-cache-1f phpdoc-cache-49 phpdoc-cache-72 phpdoc-cache-9c phpdoc-cache-c9 phpdoc-cache-f3
js phpdoc-cache-20 phpdoc-cache-4a phpdoc-cache-74 phpdoc-cache-9e phpdoc-cache-ca phpdoc-cache-f5
namespaces phpdoc-cache-23 phpdoc-cache-4f phpdoc-cache-76 phpdoc-cache-a4 phpdoc-cache-cb phpdoc-cache-f8
phpdoc-cache-01 phpdoc-cache-26 phpdoc-cache-50 phpdoc-cache-77 phpdoc-cache-a5 phpdoc-cache-cd reports
phpdoc-cache-05 phpdoc-cache-29 phpdoc-cache-51 phpdoc-cache-78 phpdoc-cache-a9 phpdoc-cache-cf
phpdoc-cache-09 phpdoc-cache-2b phpdoc-cache-54 phpdoc-cache-79 phpdoc-cache-b2 phpdoc-cache-d1
phpdoc-cache-0d phpdoc-cache-2e phpdoc-cache-58 phpdoc-cache-7d phpdoc-cache-b4 phpdoc-cache-d3
phpdoc-cache-10 phpdoc-cache-38 phpdoc-cache-5b phpdoc-cache-81 phpdoc-cache-b6 phpdoc-cache-d5
phpdoc-cache-13 phpdoc-cache-39 phpdoc-cache-5e phpdoc-cache-86 phpdoc-cache-bc phpdoc-cache-d7
运行index.html ,可以看到生成的文档了