使用PHP Documentor

因为刚开始使用phpdocumentor，所以写下了一些笔记。我使用的是Mac（Yosemite）环境。

安装

安装可以使用pear或composer。基本上我认为是使用composer，但是官方推荐使用pear。

梨

梨的安装通常需要使用sudo命令。可以通过phpdoc -V命令来确认是否安装成功。

sudo pear channel-discover pear.phpdoc.org
sudo pear install phpdoc/phpDocumentor
phpdoc -V

目前版本似乎是2.8.5。

檢查梨是否需要進行升級。

就算忘记了也要记下来。

sudo pear list-upgrades

确认一下。
实际的升级是，

sudo pear upgrade <package>

设想一下。

作曲家

现今，是作曲家的时代。

composer require --dev phpdocumentor/phpdocumentor

看起来可以。
使用时，请

php vendor/bin/phpdoc

以动力驱动。

使用（指令）

基本上 (jī

phpdoc run -d /コード -t /出力先

可以指定模板。

phpdoc run -d /コード -t /出力先 --template=clean

有多种模板可供选择。

phpdoc template:list

可以在其中得到确认。当你需要改变心情时，这会很好。当然，你也可以自己创建原始模板。

利用 (代码) / 利用 (程式代码)

输出用的最低限度样本。

例如，在测试文件夹中创建一个名为test.php的文件。

<?php

/**
 * ファイル自体のサマリを書く。書かないと怒られる。
 */


/**
 * 加算機能（概要を書く）。
 *
 * 2つのパラーメータを受け取り加算して返す（詳細を書く）。
 *
 * @param int $x 足し算用パラメータ。
 * @param int $y 足し算用パラメータ。
 *
 * @return int $ans 返り値。
 *
 */
function add($x,$y)
{
    $ans = $x + $y;
    return $ans;
}

/**
 * 減算機能（概要を書く）
 *
 * 2つのパラーメータを受け取り減算して返す（詳細を書く）。
 *
 * @param int $x 引き算用パラメータ。
 * @param int $y 引き算用パラメータ。
 *
 * @return int $ans 返り値。
 *
 */
function sub($x,$y)
{
    $ans = $x + $y;
    return $ans;
}

因此，

phpdoc -d test -t out

如果按照这样的话，文档会被输出到out文件夹。打开out/index.html文件。

成为这样。

基本上，只需要列出功能概述、参数和返回值即可。
如有需要，可以查看官方网站的文档获取更详细的信息。