20090629 Using phpDocumentor

  • 1,170 views
Uploaded on

 

More in: Technology
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Be the first to comment
No Downloads

Views

Total Views
1,170
On Slideshare
0
From Embeds
0
Number of Embeds
0

Actions

Shares
Downloads
7
Comments
0
Likes
2

Embeds 0

No embeds

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
    No notes for slide

Transcript

  • 1. phpDocumentor Rimpei Ogawa 2009/6/29 -
  • 2. • “Writing good documentation is essential to the success of any software project.” http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/ tutorial_phpDocumentor.pkg.html • OSS
  • 3. • ➡ • ➡ API
  • 4. phpDocumentor
  • 5. phpDocumentor • Automatic Documentation System
  • 6. phpDocumentor • Automatic Documentation System • for PHP code
  • 7. phpDocumentor • Automatic Documentation System • for PHP code • written in PHP
  • 8. phpDocumentor • Automatic Documentation System • for PHP code • written in PHP PHP PHP API
  • 9. • PEAR API Documentation http://pear.php.net/package/Auth/docs/latest/ • Zend Framework http://framework.zend.com/apidoc/core/ • symfony http://www.symfony-project.org/api/1_2/
  • 10. • PEAR ‣ pear install PhpDocumentor
  • 11. • • • DocBlock
  • 12. DocBlock
  • 13. DocBlock /**
  • 14. DocBlock /** * Short description *
  • 15. DocBlock /** * Short description * * Long description. This is an sample function * to show the DocBlock format. * * 2nd paragraph of long description. *
  • 16. DocBlock /** * Short description * * Long description. This is an sample function * to show the DocBlock format. * * 2nd paragraph of long description. * * @tag1 * @tag2 */ function example()
  • 17. Short Description • DocBlock • •3 1 Long Description
  • 18. Long Description • SGML • • <p>
  • 19. Long Description • HTML • b, code, br, i, kbd, li, ol, p, pre, samp, ul, var • Short description
  • 20. Long Description • /** * - unordered item A * - unordered item B * * 1 ordered item A * 2 ordered item B */
  • 21. Long Description • • <ul> “-”, “+”, “#”, “o” • <ol> “1”, “1.” • NG •
  • 22. Tags •@ • @author @package @param @version 30 • {@tagname}
  • 23. @author @author authorname <name@example.com> • •
  • 24. @license @license URL name of license • URL • @license http://opensource.org/licenses/gpl- license.php GNU Public License
  • 25. @deprecated @deprecated version/info string • • @deprecated deprecated since version 2.0 @deprecated
  • 26. @package • • DocBlock @package
  • 27. @subpackage • • @package
  • 28. @param @param datatype $paramname description • • Type Hinting PHP • @param int $num @param bool|string $foo a bool or string param
  • 29. @return @return datatype description • • PHP • @return mixed @return FooClass|false FooClass object or error
  • 30. PHP http://www.php.net/manual/ja/language.types.php
  • 31. PHP5 • • @abstract • @access {private|protected|public} • @final • @static
  • 32. DocBlock Template • • DocBlock Template
  • 33. DocBlock Template /**#@+ * @access private * @var string */ var $_var1 = ‘Hello’; var $_var2 = ‘World’; ... var $_varN; /**#@-*/ // var $varX = array();
  • 34. • phpdoc • • HTML <meta> OK
  • 35. • -d : • -t : • -o :
  • 36. • • HTML - Smarty • CHM - Windows Help • PDF - Adobe Acrobat • XML:DocBook -
  • 37. Web http://www.phpdoc.org/