News Feed
Sections




News Archive
Looking for more information on how to do PHP the right way? Check out PHP: The Right Way

SitePoint PHP Blog:
Keeping Your PHP Code Well Documented
February 19, 2014 @ 10:15:19

The SitePoint PHP blog has a new post by Jacek Barecki talking about documenting your code and some suggestions for keeping this documentation useful.

Pretty much every PHP developer writes comments along with the actual code. But the language itself doesn't impose any rules on how to do so. You just have to wrap them around some specific tags and then you can write any content you want. So what exactly should be put in the comment blocks to keep them useful? Which parts of the code should be documented and which shouldn't? In this article I will present some important rules which may help you in keeping your PHP code well documented and understandable.

There's three suggestions included in the article, each with a bit of explanation and a few screenshots to illustrate:

  • Write code that explains itself
  • Keep the balance
  • Remember about the doc blocks
0 comments voice your opinion now!
documentation understandable useful tips tutorial

Link: http://www.sitepoint.com/keeping-php-code-well-documented/

blog comments powered by Disqus

Similar Posts

Rob Allen's Blog: MongoDB on OS X with the stock PHP installation

Pádraic Brady's Blog: The Factory and Abstract Factory patterns in PHP

AirPair.com: Best Practices for Modern PHP Development

Gergely Hodicska's Blog: What's new in PHP 5.3 - part 1: namespaces

Davey Shafik's Blog: Debugging on the Command Line with xdebug


Community Events

Don't see your event here?
Let us know!


community php7 introduction api part2 list composer symfony series interview podcast language laravel programming example application yii2 framework project opinion

All content copyright, 2015 PHPDeveloper.org :: info@phpdeveloper.org - Powered by the Solar PHP Framework