?? ???

PHPDOC (PHPDocumentor)? ???? ?? ?? ??? ?? ?? ??? ???? ? ????? ??? ?????. HTML, PDF ? CHM? ?? ?? ???? ??? ?? ? ? ??? ? ????? ?? ?? ? ?????? ?? ?? ? ? ????.

PHPDOC? DocBlocks (?? ?? C ??? ??)? ???? ?? ??? ??????. DocBlocks?? ?? ??, ??? ?? ? ??? ? ?? ?? ??? ???? ????. ??? ??? ?? ?? ??? ????

??? ?????.
• PHPDOC ???? ?? ? ???? ?? ?? ??? ????? ? ?????. ?? ?? ?? ??? ?? DocBlock?? ? ??? ???? ?? ? ???? ???? ??? ? ????.
PHPDOC? ??, ???, ?? ? ??, ??? ??, ??? ??,
• ? @? ??? ??? ?? ??? ?? ??? ??? ? ????. ??? ??? ?? ?? ??? ??? ? ??? ???? ?? ??? ????.
PHPDOC? ?? ? ??? ??? PHP ??? ???? ??? ??? ? ??? ???? ? ?????. ? ??? ??? ?? ??? ?????. ?? ? ?????? ???? ?? ???? ?? PHPDOC? ? ?????? ?????.
• @package ?? ??? ??? ?? ?? (?? ???? ????)? ??? ?????. ???? "??? ??? ??"? ??? ??? ??? ??? ???? ???????. ? ??? ????? ??? ?????? ? ?? ??? ?? ?? ??? ????? ??? ?? ?? ? ? ??? ??? ????? ??? ??? ?? ??? ???? ???? ?? ???? ?? ??????. ??? ??? ?????. PHPDOC (PHPDocumentor? ?? ??)? ?? ??? ??? ?? ?? ??? ?? ? ??? ??? ?????. ??? ?? ???? ??? ? ????? ?? ?? ? ?????? ?? ??? ?? ??? ?????. ??? HTML, PDF ? CHM? ?? ??? ?? ? ? ????. ?? ?? ??? ???? ?? IDE? PHPDOC ??? ?? ???? ?? ????? ?? ???? ??? ?? ? ? ????. PHPDOC? ???? ?? ?? (? ??)? ?? ?? ?? ? ?, ? ? ?? ? ? ??? ??? ? ?? ??? ? ????. PHPDOC? ???? ?? ?? ??? Pear? ???? ????. ??, ?? ???? ?? ?? ???????. ?? ???? ?? ?? pear.php.net/manual/en/installation.php? ??? ?????. ? ????? PHPDOC? ???? ??? ???? ??? ??? ? ??? ???? ??? ?? ??????. @subpackage
docBlocks
• docBlock? ?? ??? ?? ??? ???? ? ???? ?? ?? C ??? ?????. include()/require()? ???? ? ???? ??? ????. ?? ??? ????.

  <?php
  /**
   * 計(jì)算數(shù)組中每個(gè)元素的平方和
   *
   * 循環(huán)遍歷數(shù)組中的每個(gè)元素，將其平方，并將其添加到總和中。返回總和。
   *
   * 此函數(shù)也可以使用 array_reduce() 實(shí)現(xiàn)；
   *
   * @param array $arr
   * @return int
   * @throws Exception 如果數(shù)組中的元素不是整數(shù)
   */
  function sumOfSquares($arr) {
      $total = 0;
      foreach ($arr as $val) {
          if (!is_int($val)) {
              throw new Exception("Element is not an integer!");
          }
          $total += $val * $val;
      }
      return $total;
  }

  docBlocks?? ??? ??, ??? ?? ? ???? ? ??? ???? ????. ? ??? ?? ?? ?????. ??? ??? ??? ?? ???? ??? ??? ?????. PHPDOC? ?? ??? ?????. ??? ??? ??? ?? ?????. ??? ??? ?? ??? ????? ?? HTML ??? ?? ? ? ????. ???? ?? HTML ??? ?? ???? ?????. PHPDOC? ?? ???? ??? ?? ? ? ???? HTML ??? HTML ????? ?? ??? ??? ? ??? ????. HTML ??? ???? ?? ???? ?? ?? ??? ??????. ?? ?? :
  DocBlock? ?? ???? ??? ???? ??? ?? ??? ???? ????. ??? ?? ?? ?? ? ?? ??? ?? ?? ??? ???? ? ?????. ???? ??? ?? ?? ?????? ?? ??? ?? ? ? ????. ??? ??? ?? ??? ???? ??? ??? ??? ??? ???? ??? ? ????. ??? ?? ??? ?? PHPDOC ??? ??????.

  <?php
  /**
   * 這里是斜體標(biāo)簽的示例： >Hello, world!>
   */

  ??? ????? ??? ????? ???? ???? ?? ?? ?? ? ???? ?? ? ? ????. PHPDOC? ??? ??? ??? ???? ??? ??? ???? ???? ?? ?????. ??? ?? ? ??? ???? ?? ???? ????. ?? ??? ????? HTML ??? ??????. ??? ?? ???? ?? ???? ????.

  @ (?? ???? ?? ?? ??? ??? ???? ?? ??? ?? ?) bag @

  PHPDOC ???? ?? ? ???? ?? ?? ??? ????? ? ?????. ?? ???? ???? ?? ??? ??? ?? ? ?? ? ???? ???? ??? ? ????. ???? ????? ?? ?? ?? ??? ?? DocBlock?? ??? ??????. (?? ?? ? ??? ??? ?? ??? ?? ???? ? ??? ?????). ??? ???? ??, ??, ??, ?? ? ??? ?? ( "["? "]")? ??? ? ????. ?? ???? ???? ??? ?? ??? ????.

  <?php
  /**
   * 使用列表的示例
   *
   * PhpDoc 將正確解析此列表：
   * - 項(xiàng)目 #1
   * - 項(xiàng)目 #2
   * - 項(xiàng)目 #3
   *
   * 但不是這個(gè)列表：
   * - 項(xiàng)目 1
   *   - 項(xiàng)目 1.1
   *   - 項(xiàng)目 1.2
   * - 項(xiàng)目 2
   *
   * 請(qǐng)改用此方法創(chuàng)建嵌套列表：
   * 

  *
• 項(xiàng)目 1
*
*
• 項(xiàng)目 1.1
*
• 項(xiàng)目 1.2
* *
• 項(xiàng)目 2
* */ ?? ??? ??? ? ?? ????? ?? ??? ???? ?? ???? ?? ? ? ????. ?? ??? ????.

?? ?? ???? ???? ???? ??? ?? ??? "???"?? ?????. ?? ? ??? ?? ????? ??? ?? ???? ??? ? ????.

?? ??? ??? ? ?????

?? ?? ??? docBlocks? ???? ??? ??? ?? ????. ??? ??? ? ??? ?? ?? ?????.

• ??
???? ?? ? ?? ??? ?? ??? ??
??? ?? ??? ?? ?? ???? ??? ? ??? ? ???? ?? ??? ?? ???? ????. ????? ??? ???? ? ???? ??? ??? ?? ????.
(??, ???, ?? ? ???? ?? ?? ?????. ? ?? ?? ? ?????)
• include()/require() ??? ??
PHP ??? ??? ??? ??? ??? ??? ? ??? ???????. ?? ?? PHPDOC ?? ? ??? ??????.
• define()
(?? ? ?? ?? ??? ?????) ?? ? ?????? ???? ?? ???? ?? PHPDOC? ? ?????? ?????. ? ???? ??? ?? ??? ???? ??? PHPDOC? ?? ? ??? ? phpdoc.org?? ??? ??? ? ????.
??
? ????? PHPDOC? ?? ??? ??? ?????. ?? docblocks? ? ?? ??? ??? ????. ?? ??? ??? ?? ??? ?????? ??? ?????? PHPDOC? ???? ?? ????. ??? ?? ???? ??? ??? ????? ??? ??? ??? ?? ? ????.

(FAQ ??? ?? ??? ?? ??? ???? ?? ??? ?????)

? ??? PHPDOC ??? ?? ?????. ??? ??? PHP ??? ????? ?? ?? ??? ?????!