News Feed

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

Antonin Januska:
How To Write Code Comments Well
August 20, 2012 @ 10:17:42

In this new post Antonin Januska shares some reminders about what good code comments should look like - what needs to go in and what needs to stay out (you comment all your code, right?)

Code organization is a huge thing, especially for developers (because they deal with code), and often times it's a philosophical debate as to how code should be documented, if spaces should be used instead of tabs, what kind of documentation should be used and so on. Yet, what no one brings up is the dire issue of COMMENTING. We can all agree that comments are essential (and sometimes used to build half-ass documentation on big systems) but what no one really mentions is the fact that people are crappy commenters.

There's two topics he touches on that (surprisingly) it's easy for developers to forget when writing their code - "be informative" and "use consistent formatting". A lot of the issues could be helped if developers made more use of DocBlock formatting which many IDEs already have support for.

0 comments voice your opinion now!
code comments opinion docblock formatting informative

blog comments powered by Disqus

Similar Posts

Brian Moon's Blog: PHP Coding Standards

Stanislav Malyshev's Blog: Adding new extensions to Zend Studio

Anna Filina's Blog: Podcast About Sexism in Tech: What I Learned

Vance Lucas' Blog: NoSQL First Impressions: Object Databases Missed the Boat

Chris Roane's Blog: PHP Programmers: Stop Whining and Shut-up!

Community Events

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

install laravel framework language podcast introduction configure interview developer release wordpress refactor code opinion unittest list series threedevsandamaybe testing community

All content copyright, 2014 :: - Powered by the Solar PHP Framework