how to use phpdocument使用方法

環境準備Prepare
By yum
$ sudo yum -y install php-pear php-xml
$ sudo pear channel-discover pear.phpdoc.org
$ sudo pear install -a phpdoc/phpDocumentor
$ sudo yum install php-intl
$ sudo yum install graphviz (option)
By composer
$ sudo php composer.phar require phpdocumentor/phpdocumentor


php.ini設定
date.timezone = 'Asia/Tokyo'

生成
cd /path/to/root/of/project
phpdoc -c app/phpdoc.xml --template="clean"
phpdoc -d /path/to/source/folder
phpdoc -t /path/to/file

-c: 設定ファイルを利用すること
default config: phpdoc.dist.xml

phpdoc template:list
* abstract
* checkstyle
* clean
* new-black
* old-ocean
* responsive
* responsive-twig
* xml
* zend

Sample of phpdoc.xml

	<?xml version="1.0" encoding="UTF-8" ?>
	<phpdocumentor>
	<parser>
	<target>www/phpdoc</target>
	<encoding>utf8</encoding>
	</parser>
	<transformer>
	<target>www/phpdoc</target>
	</transformer>
	<files>
	<file>src/Controller/*</file>
	<file>tests/TestCase/Controller/*</file>
	<file>tests/TestCase/View/*</file>
	<!-- ignore -->
	<ignore>src/Controller/Component/*</ignore>
	</files>
	<transformations>
	<template name="clean"/>
	<template name="checkstyle"/>
	</transformations>
	</phpdocumentor>

view raw phpdoc.xml hosted with ❤ by GitHub