phpdoc 使用一-php教程-PHP中文网

phpdoc 使用一

php中文网

发布： 2016-07-29 09:05:16

原创

1637人浏览过

phpdoc 使用(一)

最近由于业务需要,需要开发文档,并且代码注释要写的详略得当,所以干脆按照phpdoc的格式写,用它来生成文档,文档看起来貌似还不错.

1 安装phpdoc

<code>pear channel-discover pear<span>.phpdoc</span><span>.org</span>
pear install phpdoc/phpDocumentor</code>

登录后复制

2 安装完成后,可以用 phpdoc -h 来查看phpdoc 的使用信息

<code>user@ubuntu15:/srv$ phpdoc  <span>-h</span>
Usage:
 project:run <span>[</span><span>-t</span><span>|--</span>target<span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>--</span><span>cache</span><span>-folder</span><span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>-f</span><span>|--</span>filename<span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>-d</span><span>|--</span>directory<span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>--</span>encoding<span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>-e</span><span>|--</span>extensions<span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>-i</span><span>|--</span>ignore<span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>--</span>ignore<span>-tags</span><span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>--</span>hidden<span>]</span><span>[</span><span>--</span>ignore<span>-symlinks</span><span>]</span><span>[</span><span>-m</span><span>|--</span>markers<span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>--</span>title<span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>--</span>force<span>]</span><span>[</span><span>--</span>validate<span>]</span><span>[</span><span>--</span>visibility<span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>--</span>defaultpackagename<span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>--</span>sourcecode<span>]</span><span>[</span><span>-p</span><span>|--</span>progressbar<span>]</span><span>[</span><span>--</span>template<span>[</span><span>=</span><span>"..."</span><span>]</span><span>] </span><span>[</span><span>--</span>parseprivate<span>]</span><span>[</span><span>--</span><span>log</span><span>[</span><span>=</span><span>"..."</span><span>]</span><span>]

...</span></code>

登录后复制

-d 源php文件的路径
-t 生成文档后文档的存放路径（最好为其单独创建一个文件夹）
-dn 包的名字（默认为default，最好改成项目的名字）
-dc 目录的名字（默认为default，最好改成项目的名字）
-ti 文档标题这是首页上的大标题
-o 生成的文档的模板格式，这个应该有很多种可以选择，不过我只选择：HTML:Smarty:PHP（感觉比较美观）

3 实践下

PPT.CN,PPTCN,PPT.CN是什么,PPT.CN官网,PPT.CN如何使用

一键操作，智能生成专业级PPT

查看详情

立即学习“PHP免费学习笔记（深入）”；

phpdoc -d /remote/ -t ~/Documents/

在指定的目录下生成了好多文件

<code>classes          phpdoc<span>-cache</span><span>-</span><span>15</span>  phpdoc<span>-cache</span><span>-</span><span>3</span>d  phpdoc<span>-cache</span><span>-</span><span>60</span>  phpdoc<span>-cache</span><span>-</span><span>8</span>b  phpdoc<span>-cache</span><span>-be</span>  phpdoc<span>-cache</span><span>-e2</span>
css              phpdoc<span>-cache</span><span>-</span><span>18</span>  phpdoc<span>-cache</span><span>-</span><span>41</span>  phpdoc<span>-cache</span><span>-</span><span>61</span>  phpdoc<span>-cache</span><span>-</span><span>8</span>c  phpdoc<span>-cache</span><span>-c1</span>  phpdoc<span>-cache</span><span>-e3</span>
extension<span>-src</span>    phpdoc<span>-cache</span><span>-</span><span>1</span>a  phpdoc<span>-cache</span><span>-</span><span>42</span>  phpdoc<span>-cache</span><span>-</span><span>65</span>  phpdoc<span>-cache</span><span>-</span><span>91</span>  phpdoc<span>-cache</span><span>-c6</span>  phpdoc<span>-cache</span><span>-e4</span>
files            phpdoc<span>-cache</span><span>-</span><span>1</span>b  phpdoc<span>-cache</span><span>-</span><span>43</span>  phpdoc<span>-cache</span><span>-</span><span>66</span>  phpdoc<span>-cache</span><span>-</span><span>92</span>  phpdoc<span>-cache</span><span>-c7</span>  phpdoc<span>-cache</span><span>-ed</span>
font             phpdoc<span>-cache</span><span>-</span><span>1</span>c  phpdoc<span>-cache</span><span>-</span><span>44</span>  phpdoc<span>-cache</span><span>-</span><span>6</span>f  phpdoc<span>-cache</span><span>-</span><span>9</span>a  phpdoc<span>-cache</span><span>-c8</span>  phpdoc<span>-cache</span><span>-f0</span>
graphs           phpdoc<span>-cache</span><span>-</span><span>1</span>f  phpdoc<span>-cache</span><span>-</span><span>49</span>  phpdoc<span>-cache</span><span>-</span><span>72</span>  phpdoc<span>-cache</span><span>-</span><span>9</span>c  phpdoc<span>-cache</span><span>-c9</span>  phpdoc<span>-cache</span><span>-f3</span>
js               phpdoc<span>-cache</span><span>-</span><span>20</span>  phpdoc<span>-cache</span><span>-</span><span>4</span>a  phpdoc<span>-cache</span><span>-</span><span>74</span>  phpdoc<span>-cache</span><span>-</span><span>9</span>e  phpdoc<span>-cache</span><span>-ca</span>  phpdoc<span>-cache</span><span>-f5</span>
namespaces       phpdoc<span>-cache</span><span>-</span><span>23</span>  phpdoc<span>-cache</span><span>-</span><span>4</span>f  phpdoc<span>-cache</span><span>-</span><span>76</span>  phpdoc<span>-cache</span><span>-a4</span>  phpdoc<span>-cache</span><span>-cb</span>  phpdoc<span>-cache</span><span>-f8</span>
phpdoc<span>-cache</span><span>-</span><span>01</span>  phpdoc<span>-cache</span><span>-</span><span>26</span>  phpdoc<span>-cache</span><span>-</span><span>50</span>  phpdoc<span>-cache</span><span>-</span><span>77</span>  phpdoc<span>-cache</span><span>-a5</span>  phpdoc<span>-cache</span><span>-cd</span>  reports
phpdoc<span>-cache</span><span>-</span><span>05</span>  phpdoc<span>-cache</span><span>-</span><span>29</span>  phpdoc<span>-cache</span><span>-</span><span>51</span>  phpdoc<span>-cache</span><span>-</span><span>78</span>  phpdoc<span>-cache</span><span>-a9</span>  phpdoc<span>-cache</span><span>-cf</span>
phpdoc<span>-cache</span><span>-</span><span>09</span>  phpdoc<span>-cache</span><span>-</span><span>2</span>b  phpdoc<span>-cache</span><span>-</span><span>54</span>  phpdoc<span>-cache</span><span>-</span><span>79</span>  phpdoc<span>-cache</span><span>-b2</span>  phpdoc<span>-cache</span><span>-d1</span>
phpdoc<span>-cache</span><span>-</span><span>0</span>d  phpdoc<span>-cache</span><span>-</span><span>2</span>e  phpdoc<span>-cache</span><span>-</span><span>58</span>  phpdoc<span>-cache</span><span>-</span><span>7</span>d  phpdoc<span>-cache</span><span>-b4</span>  phpdoc<span>-cache</span><span>-d3</span>
phpdoc<span>-cache</span><span>-</span><span>10</span>  phpdoc<span>-cache</span><span>-</span><span>38</span>  phpdoc<span>-cache</span><span>-</span><span>5</span>b  phpdoc<span>-cache</span><span>-</span><span>81</span>  phpdoc<span>-cache</span><span>-b6</span>  phpdoc<span>-cache</span><span>-d5</span>
phpdoc<span>-cache</span><span>-</span><span>13</span>  phpdoc<span>-cache</span><span>-</span><span>39</span>  phpdoc<span>-cache</span><span>-</span><span>5</span>e  phpdoc<span>-cache</span><span>-</span><span>86</span>  phpdoc<span>-cache</span><span>-bc</span>  phpdoc<span>-cache</span><span>-d7</span></code>

登录后复制

运行index.html ,可以看到生成的文档了

').addClass('pre-numbering').hide(); $(this).addClass('has-numbering').parent().append($numbering); for (i = 1; i ').text(i)); }; $numbering.fadeIn(1700); }); });

以上就介绍了phpdoc 使用一，包括了方面的内容，希望对PHP教程有兴趣的朋友有所帮助。

大家都在看：

PHPDoc 专家指南：掌握代码文档化的奥秘点亮代码之路：使用 PHPDoc 照亮代码库 PHP 文档化的终极指南：PHPDoc 从入门到精通踏上 PHPDoc 之旅：轻松驾驭代码文档化揭秘 PHPDoc 文档化：提升代码可读性与可维护性