Comments on: My Coding Style http://www.tutwow.com/php/my-coding-style/ Playing Creativity Tag Thu, 29 Jul 2010 18:38:29 +0000 hourly 1 http://wordpress.org/?v=3.0 By: Jon Daley http://www.tutwow.com/php/my-coding-style/comment-page-1/#comment-1420 Jon Daley Sat, 22 Aug 2009 14:14:09 +0000 http://www.tutwow.com/WP25/?p=10#comment-1420 I am big on comments, but extra comments just waste space - I only read two lines of your first example, and I think the second comment shouldn't be there: Code: unset($_SESSION["useredit"); Comment // unset the useredit variable A better comment would be *why* are you unsetting it every time it is set - perhaps it shouldn't be a session variable? I am big on comments, but extra comments just waste space – I only read two lines of your first example, and I think the second comment shouldn’t be there:

Code: unset($_SESSION[“useredit”);
Comment // unset the useredit variable

A better comment would be *why* are you unsetting it every time it is set – perhaps it shouldn’t be a session variable?

]]> By: Joe http://www.tutwow.com/php/my-coding-style/comment-page-1/#comment-1414 Joe Wed, 19 Aug 2009 11:08:28 +0000 http://www.tutwow.com/WP25/?p=10#comment-1414 What about structuring your code into classes and functions? Then you have come somewhere. And read Code Complete. What about structuring your code into classes and functions? Then you have come somewhere. And read Code Complete.

]]> By: Montana Flynn http://www.tutwow.com/php/my-coding-style/comment-page-1/#comment-1375 Montana Flynn Tue, 09 Jun 2009 07:55:32 +0000 http://www.tutwow.com/WP25/?p=10#comment-1375 Great post, I really need to start doing this with my code since I am a total novice in PHP. Thanks to Iain as well. Great post, I really need to start doing this with my code since I am a total novice in PHP. Thanks to Iain as well.

]]> By: Iain Nash - Code Joust http://www.tutwow.com/php/my-coding-style/comment-page-1/#comment-507 Iain Nash - Code Joust Tue, 07 Apr 2009 13:12:06 +0000 http://www.tutwow.com/WP25/?p=10#comment-507 Really, Really great article. However, I think this should be filed under php also... you rarely have to do this with HTML. Another thing is the general syntax for docblocks (as they are called) is /** (line) ** (line) **/, which is colored differently in IDEs and interpreted by robots (if you ever need that done) as standard documentation. And http://aptana.com/ is my favorite ide, and it colors everything, and offers a "format" function, which is nice if you copy+pasted stuff, wrote quickly and forgot to indent/space etc. And-- Don't worry about the size of your comments, they won't increase load time. The Zend articles are very good covering this. Another tidbit is that it is MUCH better to use <?php to open php, and, if your file is php-only, you don't need closing tags, in fact, that decreases the processing time. Iain Nash - http://codejoust.com/ Really, Really great article.
However, I think this should be filed under php also… you rarely have to do this with HTML.
Another thing is the general syntax for docblocks (as they are called) is /** (line) ** (line) **/, which is colored differently in IDEs and interpreted by robots (if you ever need that done) as standard documentation.
And http://aptana.com/ is my favorite ide, and it colors everything, and offers a “format” function, which is nice if you copy+pasted stuff, wrote quickly and forgot to indent/space etc.
And– Don’t worry about the size of your comments, they won’t increase load time.
The Zend articles are very good covering this.
Another tidbit is that it is MUCH better to use <?php to open php, and, if your file is php-only, you don’t need closing tags, in fact, that decreases the processing time.

Iain Nash – http://codejoust.com/

]]> By: Dale http://www.tutwow.com/php/my-coding-style/comment-page-1/#comment-4 Dale Sun, 21 Sep 2008 12:29:57 +0000 http://www.tutwow.com/WP25/?p=10#comment-4 Unlike me... who just writes a load of the code into a file and makes it nice and messy so only I can understand it. :) Unlike me… who just writes a load of the code into a file and makes it nice and messy so only I can understand it. :)

]]>