̽ÌÖ:ÈçºÎʹÓÃPhpDocumentorÉú³ÉÎĵµ

5年以前  |  阅读数:684 次  |  编程语言:PHP 

*ÃuÁiÐнʽ£º
*¡¡¡¡ÔÚphpDocumentorËuÔÚĿ¼Ï£¬ÊaÈephpdoc ¨Ch»aµÃµ½Ò»¸oÏeϸµÄ²ÎÊý±i£¬ÆaÖм¸¸oÖØÒªµÄ²ÎÊýÈçÏ£º
-f Òª½øÐÐ
ÖÎoµÄÎļþÃu£¬¶a¸oÎļþÓöººÅ¸o¿ª
-d ÒªÖÎoµÄĿ¼£¬¶a¸oĿ¼ÓöººÅÖ¸i
-t Éu³ÉµÄÎĵµµÄ´aež¶
-o Êa³oµÄÎĵµ¸ñʽ£¬½a¹¹ÎªÊa³o¸ñʽ£º×ª»»Æ÷Ãu£ºÄ£°aĿ¼¡£
¡¡ ÀýÈ磺phpdoc -o HTML:frames:earthli -f test.php -t docs

Web½çÃaeÉu³É
¡¡¡¡ÔÚеÄphpdocÖУ¬³ýÁËÔÚÃuÁiÐÐÏÂÉu³ÉÎĵµÍa£¬»¹¿ÉÒÔÔÚ¿Í»§¶Ëa¯ÀÀÆ÷ÉϲÙ×÷Éu³ÉÎĵµ£¬¾ßÌa½¨ÊÇÏÈ°ÑPhpDocumentorµÄÄÚÈÝÅÔÚapacheĿ¼ÏÂʹµÃͨ¹ýa¯ÀÀÆ÷¿ÉÒÔÃÎʵ½£¬ÃÎʺoÏÔʾÈçϵĽçÃae£º
¡¡¡¡µa»÷files°´Å¥£¬Ñ¡ÔñÒª´¦ÀiµÄphpÎļþ»oÎļþ¼Ð£¬»¹¿ÉÒÔͨ¹ý¸ÃÖ¸¶¨¸Ã½çÃaeϵÄFiles to ignoreÀ´ºoÂÔ¶ÔijÐ(C)ÎļþµÄ´¦Ài¡£
¡¡¡¡È»ºoµa»÷output°´Å¥À´Ñ¡ÔñÉu³ÉÎĵµµÄ´ae
ž¶ºÍ¸ñʽ.
¡¡¡¡×iºoµa»÷create£¬phpdocumentor¾Í»a×Ô¶¯¿ªÊ¼Éu³ÉÎĵµÁË£¬×iÏÂ
½»aÏÔʾÉu³ÉµÄ½ø¶È¼°×´Ì¬£¬Èç¹u³É¹¦£¬»aÏÔʾ
Total Documentation Time: 1 seconds
done
Operation Completed!!
È»ºo£¬ÎÒÃǾͿÉÒÔͨ¹ý²e¿´Éu³ÉµÄÎĵµÁË£¬Èç¹uÊÇpdf¸ñʽµÄ£¬Ãu×ÖĬÈÏΪdocumentation.pdf¡£
¸øphp´uÂeÌi¼Ó¹ae*¶µÄ×¢ÊÍ

PHPDocumentÊÇ´ÓÄaµÄÔ´´uÂeµÄ×¢ÊÍÖÐÉu³ÉÎĵµ£¬Òo´ËÔÚ¸øÄaµÄ³ÌÐo×o×¢Ê͵Ĺý³Ì£¬Ò²¾ÍÊÇÄa±aÖÆÎĵµµÄ¹ý³Ì¡£
¡¡¡¡´ÓÕaÒ»µaÉϽ²£¬PHPdoc´ÙʹÄaÒªÑø³ÉÁ¼ºÃµÄ±a³ÌÏ°¹ß£¬¾¡Á¿Ê¹Óùae¶£¬ÇaÎuÎÄ×ÖΪÄaµÄ³ÌÐo×o×¢ÊÍ£¬Í¬Ê±¶a¶aÉÙÉÙÒ²±ÜÃaÁËʺo±aÖÆÎĵµºÍÎĵµµÄ¸uв»Í¬²½µÄÒ»Ð(C)ÎÊÌa¡£
¡¡¡¡ÔÚphpdocumentorÖУ¬×¢ÊÍ
ÖΪÎĵµÐÔ×¢ÊͺÍÇÎĵµÐÔ×¢ÊÍ¡£
¡¡¡¡ËuνÎĵµÐÔ×¢ÊÍ£¬ÊÇÄÇÐ(C)
ÅÔÚÌض¨¹Ø¼u×ÖÇ°ÃaeµÄ¶aÐÐ×¢ÊÍ£¬Ìض¨¹Ø¼u×ÖÊÇÖ¸Äܹ»±»phpdocÖÎoµÄ¹Ø¼u×Ö£¬ÀýÈçclass£¬varµÈ£¬¾ßÌaµÄ¿É²Î¼Ó¸½Â¼1.
¡¡¡¡ÄÇÐ(C)ûÓÐÔڹؼu×ÖÇ°Ãae»oÕß²»¹ae
¶µÄ×¢Ê;ͳÆ×÷ÇÎĵµÐÔ×¢ÊÍ£¬ÕaÐ(C)×¢Êͽ«²»»a±»phpdocËuÖÎo£¬Ò²²»»a³oÏÖÔÚÄa²uÉuµÄapiÎĵ±ÖС£

ÈçºÎÊeдÎĵµÐÔ×¢ÊÍ:
¡¡¡¡ËuÓеÄÎĵµÐÔ×¢ÊͶ¼ÊÇÓÉ/*¿ªÊ¼µÄÒ»¸o¶aÐÐ×¢ÊÍ£¬ÔÚphpDocumentorÀi³ÆΪDocBlock, DocBlockÊÇÖ¸Èi¼þ¿ª¢ÈËÔ±±aдµÄ¹ØÓÚij¸o¹Ø¼u×ֵİiÖuÐÅÏ¢£¬Ê¹µÃÆaËuÈËÄܹ»Í¨¹ýËuÖªµÀÕa¸o¹Ø¼u×ֵľßÌaÓÃ;£¬ÈçºÎʹÓá£PhpDocumentor¹ae¶¨Ò»¸oDocBlock°uº¬ÈçÏÂÐÅÏ¢£º
1. ¹¦ÄܼoÊoÇø
2. Ïeϸ˵Ã÷Çø
3. ±e¼Çtag
¡¡¡¡ÎĵµÐÔ×¢Ê͵ĵÚÒ»ÐÐÊǹ¦ÄÜÃeÊoÇø£¬ÕýÎÄÒ»°aÊǼoÃ÷¶oÒªµØ˵Ã÷Õa¸oÀa£¬½¨»oÕߺ¯ÊýµÄ¹¦ÄÜ£¬¹¦ÄܼoÊoµÄÕýÎÄÔÚÉu³ÉµÄÎĵµÖн«ÏÔʾÔÚË÷ÒýÇø¡£¹¦ÄÜÃeÊoÇøµÄÄÚÈÝ¿ÉÒÔͨ¹ýÒ»¸o¿ÕÐлoÕß . À´½aÊø
¡¡¡¡
ÔÚ¹¦ÄÜÃeÊoÇøºoÊÇÒ»¸o¿ÕÐУ¬½Ó×ÅÊÇÏeϸ˵Ã÷Çø,. Õa²¿ÖÖ÷ÒªÊÇÏeϸ˵Ã÷ÄaµÄAPIµÄ¹¦ÄÜ£¬ÓÃ;£¬Èç¹u¿ÉÄÜ£¬Ò²¿ÉÒÔÓÐÓè¾ÙÀýµÈµÈ¡£ÔÚÕa²¿Ö£¬ÄaÓ¦¸Ã×ÅÖزuÃ÷ÄaµÄAPIº¯Êý»oÕß½¨µÄͨ³£µÄÓÃ;£¬Ó裬²¢ÇÒÖ¸Ã÷ÊÇñÊÇ¿çƽ̨µÄ£¨Èç¹uÉae¼°µ½£(C)£¬¶ÔÓÚºÍƽ̨Ïa¹ØµÄÐÅÏ¢£¬ÄaÒªºÍÄÇÐ(C)ͨÓõÄÐÅÏ¢Çø±ð¶Ô´ý£¬Í¨³£µÄ×o¨ÊÇÁiÆðÒ»ÐУ¬È»ºoд³oÔÚij¸oÌض¨Æ½Ì¨ÉϵÄ×¢ÒaÊÂÏi»oÕßÊÇÌرðµÄÐÅÏ¢£¬ÕaÐ(C)ÐÅÏ¢Ó¦¸Ã×a¹»£¬ÒÔ±aÄaµÄ¶ÁÕßÄܹ»±aдÏaÓ¦µÄ²aÊÔÐÅÏ¢£¬±ÈÈç±ß½çÌo¼þ£¬²ÎÊý¶Î§£¬¶ÏµaµÈµÈ¡£
¡¡¡¡
Ö®ºoͬÑuÊÇÒ»¸o¿Õ°×ÐУ¬È»ºoÊÇÎĵµµÄ±e¼Çtag£¬Ö¸Ã÷Ò»Ð(C)¼¼ÊoÉϵÄÐÅÏ¢£¬Ö÷ÒªÊÇ×iÖ÷ÒªµÄÊǵ÷ÓòÎÊýÀaÐÍ£¬
µ»ØÖµ¼«ÆaÀaÐÍ£¬¼Ì³Ð¹Øϵ£¬Ïa¹Ø½¨/º¯ÊýµÈµÈ¡£

Îĵµ×¢ÊÍÖл¹¿ÉÒÔʹÓÃÀýÈç ÕaÑuµÄ±eÇ(C)£¬Ïeϸ½eÉÜÇe²Î¿¼¸½Â¼¶þ¡£
Ò»¸oÎĵµ×¢Ê͵ÄÀý×Ó
/**

  • º¯Êýadd,ʵÏÖÁ½¸oÊýµÄ¼Ó*¨
  • Ò»¸o¼oµ¥µÄ¼Ó¨¼ÆËa£¬º¯Êý½ÓÊÜÁ½¸oÊýa¡¢b£¬µ»ØËuÃǵĺÍc
  • @param int ¼ÓÊý
  • @param int ±»¼ÓÊý
  • @return integer
    /
    function Add($a, $b)
    {
    return $a+$b;
    }
    ¡¡¡¡Éu³ÉÎĵµÈçÏ£º
    Add
    integer Add( int $a, int $b)
    [line 45]
    ¡¡¡¡º¯Êýadd,ʵÏÖÁ½¸oÊýµÄ¼Ó
    ¨
    Constants Ò»¸o¼oµ¥µÄ¼Ó¨¼ÆËa£¬º¯Êý½ÓÊÜÁ½¸oÊýa¡¢b£¬µ»ØËuÃǵĺÍc
    Parameters
    • int $a - ¼ÓÊý
    • int $b - ±»¼ÓÊý
    Îĵµ±e¼Ç£º
    ¡¡¡¡Îĵµ±e¼ÇµÄʹÓöΧÊÇÖ¸¸Ã±e¼Ç¿ÉÒÔÓÃÀ´ÐÞÊεĹؼu×Ö£¬»oÆaËuÎĵµ±e¼Ç¡£
    ¡¡¡¡ËuÓеÄÎĵµ±e¼Ç¶¼ÊÇÔÚÿһÐеÄ
    ºoÃaeÒÔ@¿ªÍ¡£Èç¹uÔÚÒ»¶Î»°µÄÖмa³oÀ´@µÄ±e¼Ç£¬Õa¸o±e¼Ç½«»a±»µ±×oÆÕͨÄÚÈݶø±»ºoÂÔµo¡£
    @access
    ¡¡¡¡Ê¹ÓÃ
    ¶Î§£ºclass,function,var,define,module
    ¡¡¡¡¸Ã±e¼ÇÓÃÓÚÖ¸Ã÷¹Ø¼u×ֵĴaeȡȨÏÞ£ºprivate¡¢public»oproteced
    @author
    ¡¡¡¡Ö¸Ã÷×÷Õß
    @copyright
    ¡¡¡¡Ê¹ÓöΧ£ºclass£¬function£¬var£¬define£¬module£¬use
    ¡¡¡¡Ö¸Ã÷°aeȨÐÅÏ¢
    @deprecated
    ¡¡¡¡Ê¹ÓÃ
    ¶Î§£ºclass£¬function£¬var£¬define£¬module£¬constent£¬global£¬include
    ¡¡¡¡Ö¸Ã÷²»ÓûoÕßÏÆuµÄ¹Ø¼u×Ö
    @example
    ¡¡¡¡¸Ã±e¼ÇÓÃÓÚ½aÎoÒ»¶ÎÎļþÄÚÈÝ£¬²¢½«ËuÃǸßÁÁÏÔʾ¡£Phpdoc»aÊÔͼ´Ó¸Ã±e¼Ç¸øµÄÎļþÂ
    ¾¶ÖжÁÈ¡ÎļþÄÚÈÝ
    @const
    ¡¡¡¡Ê¹ÓöΧ£ºdefine
    ¡¡¡¡ÓÃÀ´Ö¸Ã÷phpÖÐdefineµÄ³£Á¿
    @final
    ¡¡¡¡Ê¹ÓÃ
    ¶Î§£ºclass,function,var
    ¡¡¡¡Ö¸Ã÷¹Ø¼u×ÖÊÇÒ»¸o×iÖÕµÄÀa¡¢½¨¡¢ÊoÐÔ£¬½uÖ¹ÅÉÉu¡¢Ð޸ġ£
    @filesource
    ¡¡¡¡ºÍexampleÀaËÆ£¬Ö»²»¹ý¸Ã±e¼Ç½«Ö±½Ó¶ÁÈ¡µ±Ç°½aÎoµÄphpÎļþµÄÄÚÈݲ¢ÏÔʾ¡£
    @global
    ¡¡¡¡Ö¸Ã÷Ôڴ˺¯ÊýÖÐÒýÓõÄÈ«¾Ö±aÁ¿
    @ingore
    ¡¡¡¡ÓÃÓÚÔÚÎĵµÖкoÂÔÖ¸¶¨µÄ¹Ø¼u×Ö
    @license
    ¡¡¡¡Ïaµ±ÓÚhtml±eÇ(C)ÖеÄ,Ê×ÏÈÊÇURL£¬½Ó×ÅÊÇÒªÏÔʾµÄÄÚÈÝ
    ¡¡¡¡ÀýÈç
    °Ù¶È
    ¡¡¡¡¿ÉÒÔд×÷ @license http://www.baidu.com °Ù¶È
    @link
    ¡¡¡¡ÀaËÆÓÚlicense
    ¡¡¡¡µ«»¹¿ÉÒÔͨ¹ýlinkÖ¸µ½ÎĵµÖеÄÈκÎÒ»¸o¹Ø¼u×Ö
    @name
    ¡¡¡¡Îª¹Ø¼u×ÖÖ¸¶¨Ò»¸o±ðÃu¡£
    @package
    ¡¡¡¡Ê¹ÓöΧ£ºÒ³Ãae¼¶±ðµÄ-> define£¬function£¬include
    ¡¡¡¡Àa¼¶±ðµÄ->class£¬var£¬methods
    ¡¡¡¡ÓÃÓÚÂß¼­ÉϽ«Ò»¸o»o¼¸¸o¹Ø¼u×Ö
    Öµ½Ò»×e¡£
    @abstrcut
    ¡¡¡¡ËµÃ÷µ±Ç°ÀaÊÇÒ»¸o³eÏoÀa
    @param
    ¡¡¡¡Ö¸Ã÷Ò»¸oº¯ÊýµÄ²ÎÊý
    @return
    ¡¡¡¡Ö¸Ã÷Ò»¸o½¨»oº¯ÊýµÄµ»ØÖ¸
    @static
    ¡¡¡¡Ö¸Ã÷¹Ø½¨×ÖÊǾ²Ì¬µÄ¡£
    @var
    ¡¡¡¡Ö¸Ã÷±aÁ¿ÀaÐÍ
    @version
    ¡¡¡¡Ö¸Ã÷°ae±¾ÐÅÏ¢
    @todo
    ¡¡¡¡Ö¸Ã÷Ó¦¸Ã¸Ä½ø»oûÓÐʵÏֵĵØ
    ½
    @throws
    ¡¡¡¡Ö¸Ã÷´Ëº¯Êý¿ÉÄÜÅ׳oµÄ´iÎoÒi³£,¼«Æa¢ÉuµÄÇe¿o
    ¡¡¡¡ÉÏÃaeÌaµ½¹ý£¬ÆÕͨµÄÎĵµ±e¼Ç±e¼Ç±ØÐeÔÚÿÐеĿªÍ
    ÒÔ@±e¼Ç£¬³ý´ËÖ®Ía£¬»¹ÓÐÒ»ÖÖ±e¼Ç½Ð×oinline tag,ÓÃ{@}±iʾ£¬¾ßÌa°uÀ¨ÒÔϼ¸ÖÖ£º
    {@link}
    ¡¡¡¡Óèͬ@link
    {@source}
    ÏÔʾһ¶Îº¯Êý»o
    ½*¨µÄÄÚÈÝ

*Ò»Ð(C)×¢Ê͹ae
a.×¢ÊͱØÐeÊÇ
/

  • XXXXXXX
    /
    ¡¡¡¡µÄÐÎʽ
    b.¶ÔÓÚÒýÓÃÁËÈ«¾Ö±aÁ¿µÄº¯Êý£¬±ØÐeʹÓÃglboal±e¼Ç¡£
    c.¶ÔÓÚ±aÁ¿£¬±ØÐeÓÃvar±e¼ÇÆaÀaÐÍ£¨int,string,bool...£(C)
    d.º¯Êý±ØÐeͨ¹ýparamºÍreturn±e¼ÇÖ¸Ã÷Æa²ÎÊýºÍ
    µ»ØÖµ
    e.¶ÔÓÚ³oÏÖÁ½´Î»oÁ½´ÎÒÔÉϵĹؼu×Ö£¬ÒªÍ¨¹ýingoreºoÂÔµo¶aÓaµÄ£¬Ö»±£ÁoÒ»¸o¼´¿É
    f.µ÷ÓÃÁËÆaËuº¯Êý»oÀaµÄµØ½£¬ÒªÊ¹ÓÃlink»oÆaËu±e¼ÇÁ´½Óµ½ÏaÓ¦µÄ²¿Ö£¬±aÓÚÎĵµµÄÔĶÁ¡£
    g.±ØÒªµÄµØ½Ê¹ÓÃÇÎĵµÐÔ×¢ÊÍ£¬Ìa¸ß´uÂeÒ׶ÁÐÔ¡£
    h.ÃeÊoÐÔÄÚÈݾ¡Á¿¼oÃ÷¶oÒª£¬¾¡¿ÉÄÜʹÓöÌÓi¶ø*Ǿa×Ó¡£
    i.È«¾Ö±aÁ¿£¬¾²Ì¬±aÁ¿ºÍ³£Á¿±ØÐeÓÃÏaÓ¦±e¼Ç˵Ã÷

×ܽa
phpDocumentorÊÇÒ»¸odz£Ç¿´oµÄÎĵµ×Ô¶¯Éu³É¹¤¾ß£¬ÀuÓÃËu¿ÉÒÔ°iÖuÎÒÃDZaд¹ae¶µÄ×¢ÊÍ£¬Éu³ÉÒ×ÓÚÀi½a£¬½a¹¹ÇaÎuµÄÎĵµ£¬¶ÔÎÒÃǵĴuÂeÉý¼¶£¬Î¬»¤,Òƽ»µÈ¶¼ÓÐdz£´oµÄ°iÖu¡£
¹ØÓÚphpDocumentor¸uΪÏeϸµÄ˵Ã÷£¬¿ÉÒÔµ½ËuµÄ¹Ù
½ÍøÕ¾

Á½¸oÀý×Ó£º
ʵÀýÒ»
ʵÀý¶þ

 相关文章:
PHP分页显示制作详细讲解
SSH 登录失败:Host key verification failed
获取IMSI
将二进制数据转为16进制以便显示
获取IMEI
文件下载
贪吃蛇
双位运算符
PHP自定义函数获取搜索引擎来源关键字的方法
Java生成UUID
发送邮件
年的日历图
提取后缀名
在Zeus Web Server中安装PHP语言支持
让你成为最历害的git提交人
Yii2汉字转拼音类的实例代码
再谈PHP中单双引号的区别详解
指定应用ID以获取对应的应用名称
Python 2与Python 3版本和编码的对比
php封装的page分页类完整实例