February 2018 WordPress Ahmedabad Meetup

Want to follow standard coding? Learn DocBlock and PHPDoc first . - Priyanka Behera

Transcript

1. Want to follow standard coding? Learn DocBlock and PHPDoc first PRIYANKA BEHERA WordPress Developer Multidots Solutions Pvt Ltd
2. What we going to cover today in this session ?
3. Commenting Documentation
4. What we actually do in the name of Commenting Doc?
5. //
6. What should we Learn in commenting documentation?
7. PHPDoc
8. What is PHPDoc?
9. "PHPDoc" is a section of documentation which provides information on aspects of a "Structural Element"
10. Structural Element
11. Structural Element "Structural Element" is a collection of Programming Constructs which MAY be preceded by a DocBlock. The collection contains the following constructs: • file • require(_once) • include(_once) • class • interface • trait • function (including methods) • property • constant • variables, both local and global scope.
12. DocCommenting
13. "DocComment" is a special type of comment which MUST • start with the character sequence /** followed by a whitespace character • end with */ and • have zero or more lines in between.
14. Basic Principles/rules of DocCommenting
15. 1. A DocBlock MUST directly precede a "Structural Element" 2. File-level DocBlock which MUST be placed at the top of a PHP source code file as the first DocBlock in a file. 3. Structural Element comes directly after a File-level DocBlock MUST that element have its own DocBlock in addition to the File-level DocBlock.
17. DocBlock
18. "DocBlock" is a "DocComment" containing a single "PHPDoc" structure and represents the basic in-source representation.
19. PHPDoc contain following element • Summary • Description • Tags
20. Tags
21. Class Or Interface • @package • @subpackage Method • @param • @returm • @access
22. Some other popular and important tags • @deprecated • @global • @since • @todo • @var • @version
23. You can also configure the PHPDoc to the editor itself for better coding and automatic comment documentation. - PhpStorm - Sublime
24. How can I contribute to WordPress with the knowledge of PHPDoc and DocBlock?
25. https://core.trac.wordpress.org/ticket/40231 https://profiles.wordpress.org/priyankabehera 155
26. Referral Link https://github.com/phpDocumentor/fig-standards/blob/master/proposed/phpdoc.md https://make.wordpress.org/core/handbook/best-practices/coding-standards/php/ http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_p hpDocumentor.pkg.html https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standa rds/php/