phpDocumentor
Ìܼ¡
1 phpDocumentor¤Î¥¤¥ó¥¹¥È¡¼¥ë
1-1 ¥Ñ¥Ã¥±¡¼¥¸¤ÎÆþ¼ê
1-2 ¥¤¥ó¥¹¥È¡¼¥ë (Unix/Linux)
1-3 ¼Â¹Ô
1-4 ¤½¤Î¾ÊäÂ
2 »È¤¤Êý
2-1 phpdoc¥³¥Þ¥ó¥É¤Î¼Â¹Ô
2-2 ¥³¥á¥ó¥È¤ÎµÆþ¤Ë¤Ä¤¤¤Æ
¡¦ ´ðËÜ
¡¦ Äê¿ô¤Î¥³¥á¥ó¥È
¡¦ @author
¡¦ @global
2-3 ¥¿¥°¤Ë¤Ä¤¤¤Æ
¡¦ @link
¡¦ @package
¡¦ @param
¡¦ @return
¡¦ @see
¡¦ @subpackage
¡¦ @var
2-4 ¥¤¥ó¥é¥¤¥ó¤Î¥¿¥°¤Ë¤Ä¤¤¤Æ
¡¦ @link
2-5 ¤Á¤ç¤Ã¤È¤·¤¿¥á¥â
¡¦ Âоݥե¡¥¤¥ë³ÈÄ¥»Ò¤ÎÀßÄê
PHP¥¹¥¯¥ê¥×¥È¤ËËä¤á¹þ¤ó¤À¥³¥á¥ó¥È¤«¤é¡¢¥É¥¥å¥á¥ó¥È¥Ú¡¼¥¸¡ÊHTML)¤òÀ¸À®¤·¤Æ¤¯¤ì¤ë¥Ä¡¼¥ë¤Ç¤¹¡£
¼«Ê¬¤Ç¤»¤³¤»¤³¤ÈWord¤È¤«¤Ë¤Þ¤È¤á¤ë¤è¤ê¤â¥é¥¯¤Ç¤¹¤·¡¢²¿¤è¤ê¥³¥á¥ó¥È¤È¤·¤Æµ½Ò¤â¤µ¤ì¤ë¤ï¤±¤Ç¤¹¤«¤é
¸«Ä¾¤¹¤È¤¤â»²¾È¤·¤Ê¤¯¤Æ¤â¤è¤¤¤«¤é¥é¥¯¡£
¥³¥á¥ó¥È¹¹¿·¤·¤Æ¤â¥³¥Þ¥ó¥É°ìȯ¤Ç¥É¥¥å¥á¥ó¥È¹¹¿·¤â½ÐÍè¤ë¤«¤é¼ê´Ö¤â¾Ê¤±¤ë¤È¡£
¤¿¤À°ìÀ£Æ³Æþ¤Ë¼ê´Ö¼è¤Ã¤¿¤Î¤Ç¡¢´Êñ¤Ë¥á¥â¤ò½ñ¤¤¤Æ¤ª¤³¤¦¤È»×¤¦¼¡Âè¤Ç¤¹¡£
1 phpDocumentor¤Î¥¤¥ó¥¹¥È¡¼¥ë
1-1 ¥Ñ¥Ã¥±¡¼¥¸¤ÎÆþ¼ê
phpDocumentor¤Î¸ø¼°¥µ¥¤¥È¤è¤ê¥¢¡¼¥«¥¤¥Ö¤ò¥À¥¦¥ó¥í¡¼¥É¤·¤Æ¤¤Þ¤¹¡£
1-2 ¥¤¥ó¥¹¥È¡¼¥ë (Unix/Linux)
¥Ñ¥Ã¥±¡¼¥¸¤Ïtar.gz·Á¼°¤Ç°µ½Ì¤µ¤ì¤Æ¤¤¤Þ¤¹¤Î¤Ç¡¢tar -zxf¤Ç²òÅष¤Æ¤¯¤À¤µ¤¤¡£
²òÅà¸å¡¢phpDocumentor-<¥Ð¡¼¥¸¥ç¥ó>¤È¤¤¤¦¥Ç¥£¥ì¥¯¥È¥ê¤¬½ÐÍè¤ë¤È»×¤¤¤Þ¤¹¡£
¤½¤Î¥Ç¥£¥ì¥¯¥È¥ê¤òǤ°Õ¤Î¾ì½ê¤Ë°ÜÆ°¤¹¤ì¤ÐOK¤Ç¤¹¡£
¤Þ¤¿¡¢phpDocumentor-xxx/phpdoc¤È¤¤¤¦¥·¥§¥ë¥¹¥¯¥ê¥×¥È¤ÎÃæ¤Ë¤¢¤ë¡¢PHP="/usr/bin/php"¤Ëphp¥³¥Þ¥ó¥É¤Ø¤Î¥Ñ¥¹¤ò¡¢³Æ¼«¤Î´Ä¶¤Ë¹ç¤ï¤»¤ÆÀßÄꤷ¤Æ¤¯¤À¤µ¤¤¡£
1-3 ¼Â¹Ô
phpDocumentor¥¤¥ó¥¹¥È¡¼¥ë¥Ç¥£¥ì¥¯¥È¥ê°Ê²¼¤Ë¤¢¤ë¡¢phpdoc¥Õ¥¡¥¤¥ë¤¬Ëܼ¹ԥե¡¥¤¥ë¤È¤Ê¤ê¤Þ¤¹¡£
phpDocumentor¥¤¥ó¥¹¥È¡¼¥ë¥Ç¥£¥ì¥¯¥È¥ê°Ê²¼¤Ë°ÜÆ°¤·¡¢./phpdoc¤Ç¼Â¹Ô¤·¤Þ¤¹¡£
1-4 ¤½¤Î¾ÊäÂ
°·¤¤¤Ï¥·¥§¥ë¥¹¥¯¥ê¥×¥È/PHP¥¹¥¯¥ê¥×¥È¤ÈÊѤï¤ê¤Þ¤»¤ó¤Î¤Ç¡¢phpDocumentor¥¤¥ó¥¹¥È¡¼¥ë¥Ç¥£¥ì¥¯¥È¥ê¤òinclude_path¤Ë´Þ¤á¡¢phpdoc¤Ø¤Î¥·¥ó¥Ü¥ê¥Ã¥¯¥ê¥ó¥¯¤ò/usr/bin¤¢¤¿¤ê¤ËÀßÄꤹ¤ë¡¢¤Ê¤É¤Î¤Û¤¦¤¬¥é¥¯¤«¤â¤·¤ì¤Þ¤»¤ó¡£
phpDocumentor¤Ïpear¤Î¤Û¤¦¤«¤é¤â¥¤¥ó¥¹¥È¡¼¥ë¤¬²Äǽ¤Ç¤·¤¿¤¬¡¢pear¤Î¤Û¤¦¤Ï¥¦¥Á¤Î´Ä¶¤Ç¤ÏÆ°ºî¤¬²ø¤·¤«¤Ã¤¿¤Ç¤¹¡£
¤Þ¤¿pear¤ÎphpDocumentor¤ò¥¤¥ó¥¹¥È¡¼¥ë¤·¤Æ¤¤¤ë¤È¤½¤Á¤é¤¬Í¥À褵¤ì¤ë¤¿¤á¡¢¼êÆ°¤ÇÀßÄꤷ¤¿ÆâÍƤ¬È¿±Ç¤µ¤ì¤Ê¤«¤Ã¤¿¤ê¡¢¥Ð¡¼¥¸¥ç¥ó¸ß´¹¤ÎÌäÂ꤬ȯÀ¸¤·¤¿¤ê¤¹¤ë²ÄǽÀ¤¬¤¢¤ê¤Þ¤¹¡£
¥Ú¡¼¥¸¤ÎINDEX¤Ø
2 »È¤¤Êý
»ê¶Ëñ½ã¤ÊÏá¢php¥¹¥¯¥ê¥×¥È¤Ë°ìÄê¤Î·Á¼°¤Ç¥³¥á¥ó¥È¹Ô¤òµÆþ¤·¡¢¤½¤ì¤òÆɤ߹þ¤Þ¤»¤Þ¤¹¡£
¤¹¤ë¤È»ØÄꤷ¤¿¥Ç¥£¥ì¥¯¥È¥ê¤Ë¥É¥¥å¥á¥ó¥ÈHTML¥Õ¥¡¥¤¥ë¤¬À¸À®¤µ¤ì¤Þ¤¹¡£
2-1 phpdoc¥³¥Þ¥ó¥É¤Î¼Â¹Ô
> phpdoc -d <PHP¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤Î¥Ç¥£¥ì¥¯¥È¥ê> -t <¥É¥¥å¥á¥ó¥È¤òÀ¸À®¤¹¤ë¥Ç¥£¥ì¥¯¥È¥ê>
<¥É¥¥å¥á¥ó¥È¤òÀ¸À®¤¹¤ë¥Ç¥£¥ì¥¯¥È¥ê>Æâ¤Ë¡¢¥½¡¼¥¹¥Õ¥¡¥¤¥ë¤ò¸µ¤È¤·¤¿¥É¥¥å¥á¥ó¥È°ì¼°¤¬À¸À®¤µ¤ì¤Æ¤¤¤Þ¤¹¡£
2-2 ¥³¥á¥ó¥È¤ÎµÆþ¤Ë¤Ä¤¤¤Æ
¾Ü¤·¤¯¤ÏËܲȥ桼¥¶¡¼¥º¥Þ¥Ë¥å¥¢¥ë¤ò»²¾È¤¯¤À¤µ¤¤¡£
¤è¤¯¸¯¤¤¤½¤¦¤Ê¤â¤Î¤ò¥á¥â¤·¤Æ¤ª¤¤Þ¤¹¡£
¡¦ ´ðËÜ
/** ... */¤Ç°Ï¤ó¤À¥³¥á¥ó¥È¤¬¡¢½èÍý¤ÎÂоݤȤʤê¤Þ¤¹¡£
Î㤨¤ÐºÇ½é¤Î¥Õ¥¡¥¤¥ëÀâÌÀ¤Ç¤Ï¡¢
/**
* ¥Õ¥¡¥¤¥ë¤ÎÀâÌÀ (°ì¹Ô)
*
* ¥Õ¥¡¥¤¥ë¤ÎÀâÌÀ (Ê£¿ô¹Ô)
* HTML¤ËÈ¿±Ç¤µ¤ì¤¿¤È¤²þ¹Ô¤Ï¤µ¤ì¤Ê¤¤
* @package ¥Ñ¥Ã¥±¡¼¥¸
* @author Ãøºî¼Ô
* @version 1.00
*/
¤Ê¤É¤È½ñ¤¤Þ¤¹¡£
/** ¥³¥á¥ó¥È¤È¤« */
¤Î¤è¤¦¤Ë°ì¹Ô¤Ë¤Þ¤È¤á¤ë¤³¤È¤â²Äǽ¤Ç¤¹¡£
¤Þ¤¿¡¢°Ê²¼¤ÎHTML¥¿¥°¤¬»ÈÍѲÄǽ¤Ç¡¢HTML¥É¥¥å¥á¥ó¥È½ÐÎÏ»þ¤ËÈ¿±Ç¤µ¤ì¤Þ¤¹¡£
(phpDocumentor Tutorial¤è¤ê°úÍÑ)
<b> -- emphasize/bold text
<code> -- Use this to surround php code, some converters will highlight it
<br> -- hard line break, may be ignored by some converters
<i> -- italicize/mark as important
<kbd> -- denote keyboard input/screen display
<li> -- list item
<ol> -- ordered list
<p> -- If used to enclose all paragraphs, otherwise it will be considered text
<pre> -- Preserve line breaks and spacing, and assume all tags are text (like XML's CDATA)
<samp> -- denote sample or examples (non-php)
<ul> -- unordered list
<var> -- denote a variable name
¡¦ Äê¿ô¤Î¥³¥á¥ó¥È
Äê¿ôÄêµÁ¤ÎÁ°¤Ë¥³¥á¥ó¥È¤·¤¿¤â¤Î¤¬»È¤ï¤ì¤ë¡£
/**
* Äê¿ô¤Î¥³¥á¥ó¥È¤Ç¤¹
*/
define ("DEF_VALUE", 1);
¡¦ @author
@author Ãøºî¼Ô
Ãøºî¼Ô¤òµºÜ¤·¤Þ¤¹¡£
¡¦ @global
@global ·¿ $¥°¥í¡¼¥Ð¥ëÊÑ¿ô̾
@global ·¿ ¥³¥á¥ó¥È
¥°¥í¡¼¥Ð¥ëÊÑ¿ô¤È¤·¤Æ¤Î¥³¥á¥ó¥È¤òµÆþ¤·¤Þ¤¹¡£
/**
* ¥°¥í¡¼¥Ð¥ëÊÑ¿ô¤ÎÀâÌÀ
* @global boolean $global_flg
*/
$global_flg=true;
¤Î¤è¤¦¤Ë¡¢¤Ò¤È¤Ä¤Å¤ÄµÆþ¤·¤Þ¤¹¡£
2-3 ¥¿¥°¤Ë¤Ä¤¤¤Æ
¡¦ @link
@link ¥ê¥ó¥¯ÀèURL ɽ¼¨ÍÑʸ»ú
URL¤Ïhttp://¤«¤éµÆþ¤·¤Þ¤¹¡£
¡¦ @package
@package ¥Ñ¥Ã¥±¡¼¥¸Ì¾
Åö³º¥Õ¥¡¥¤¥ë(¤ÈÅö³º¥Õ¥¡¥¤¥ë¤Ë´Þ¤Þ¤ì¤Æ¤¤¤ë¥¯¥é¥¹)¤Î¥Ñ¥Ã¥±¡¼¥¸¤ò»ØÄꤷ¤Þ¤¹¡£
»ØÄ꤬¤Ê¤¤¾ì¹ç¤Ïdefauit¤Ë¥«¥Æ¥´¥é¥¤¥º¤µ¤ì¤Þ¤¹¡£
¡¦ @param
@param ·¿ $¥Ñ¥é¥á¡¼¥¿ÊÑ¿ô̾ ¥³¥á¥ó¥È
´Ø¿ô¤Î°ú¿ô¤È¤Ê¤ë¥Ñ¥é¥á¡¼¥¿¤òµºÜ¤·¤Þ¤¹¡£
¡¦ @return
@return ·¿ ¥³¥á¥ó¥È
´Ø¿ô¤ÎÌá¤êÃͤòµÆþ¤·¤Þ¤¹¡£
¡¦ @see
@see »²¾ÈÀè´Ø¿ô¡¢¥Õ¥¡¥¤¥ë̾¤Þ¤¿¤Ï¥¯¥é¥¹Ì¾
»²¾È¤¹¤ëÀè¤Î´Ø¿ô¤Þ¤¿¤Ï¥¯¥é¥¹Ì¾¤ò»ØÄꤹ¤ë¤È¡¢¤½¤Î¾ì½ê¤Ø¤Î¥ê¥ó¥¯¤¬ºîÀ®¤µ¤ì¤Þ¤¹¡£
¥Õ¥¡¥¤¥ë̾¤Î¾ì¹ç¤Ï¡ã¥Õ¥¡¥¤¥ë̾¡ä¡¢
´Ø¿ô¤Î¾ì¹ç¤Ï¡ã´Ø¿ô̾¡ä()¡¢
¥¯¥é¥¹¤Î¾ì¹ç¤Ï¡ã¥¯¥é¥¹Ì¾¡ä¡¢
¥¯¥é¥¹Æâ¤Î´Ø¿ô¤Î¾ì¹ç¤Ï¡ã¥¯¥é¥¹Ì¾¡ä::¡ã´Ø¿ô̾¡ä()
¤È¤·¤Þ¤¹¡£
¡¦ @subpackage
@subpackage ¥µ¥Ö¥Ñ¥Ã¥±¡¼¥¸Ì¾
¥Ñ¥Ã¥±¡¼¥¸¤ï¤±¤ò¹Ô¤Ã¤¿²¼¤Ë¡¢¤µ¤é¤Ë¤â¤¦°ìÃʥѥ屡¼¥¸Ê¬¤±¤ò»ØÄꤷ¤Þ¤¹¡£
¡¦ @var
@var ·¿ ÀâÌÀ
¥¯¥é¥¹Æâ¤ÇÄêµÁ¤µ¤ì¤¿varÊÑ¿ô¤ÎÀâÌÀ¤Ç¤¹¡£
2-4 ¥¤¥ó¥é¥¤¥ó¤Î¥¿¥°¤Ë¤Ä¤¤¤Æ
¥³¥á¥ó¥ÈÃæ¤ËµÆþ¤¹¤ë¥¿¥¤¥×¤Î¥¿¥°¤Ç¤¹¡£{@link <URL¤Þ¤¿¤Ï´Ø¿ô̾>}¤Ê¤É¤È¤·¤Þ¤¹¡£
¡¦ @link
¥¿¥°¤Î@link ¤Þ¤¿¤Ï @see¤ò»²¾È
2-5 ¤Á¤ç¤Ã¤È¤·¤¿¥á¥â
¡¦ Âоݥե¡¥¤¥ë³ÈÄ¥»Ò¤ÎÀßÄê
phpDocumentor¤Ç¤Ï¡¢½èÍýÂоݤΥե¡¥¤¥ë¤«¤òȽÃǤ¹¤ëºÝ¤Ë¡¢¤Þ¤º³ÈÄ¥»Ò¤ÇȽÃǤ·¤è¤¦¤È¤·¤Þ¤¹¡£
Âбþ¤¹¤ë³ÈÄ¥»Ò¤òÁý¤ä¤·¤¿¤¤/¸º¤é¤·¤¿¤¤¾ì¹ç¤Ï¡¢phpDocumentor.ini¥Õ¥¡¥¤¥ëÆâ¤Î
[_phpDocumentor_phpfile_exts]
°Ê²¼¤ËÎóµó¤µ¤ì¤Æ¤¤¤ë³ÈÄ¥»Ò¤òÄ´À°¤·¤Æ¤¯¤À¤µ¤¤¡£
¥Ç¥Õ¥©¥ë¥È¤Ç¤Ïphp, php3, php4, phtml, inc¤¬½èÍýÂоݤȤ·¤ÆÀßÄꤵ¤ì¤Æ¤Þ¤¹¤¬¡¢
Î㤨¤Ð¡¢*.phl¥Õ¥¡¥¤¥ë¤âÄɲä·¤¿¤¤¤È»×¤Ã¤¿¤È¤¤Ï¡¢°ì¹ÔÄɲä·¤Æphl¤ÈµÆþ¤·¤Þ¤¹¡£
¥Ú¡¼¥¸¤ÎINDEX¤Ø
TIPS INDEX¤Ø
Last modified: Sun Jun 23 19:26:31 2004