Skip to main content

Posts

Showing posts with the label how to comment in php

Comments

               When it comes to commenting code, the consensus is it is necessary but the reality is it rarely is done.  It has been said that commenting code is like cleaning the bathroom - no one ever wants to do it but a clean bathroom creates a more pleasant experience for all that will need to use it.  There are many types of commenting strategies with each having advantages  and disadvantages over each other.  The key is to comment, how that is accomplished is best worked within a team environment and calls for a great deal of flexibility.  The following are types of typical commenting that should be considered along with how they would be implemented inside of PHP code:  Code Commenting  This form of commenting is not considered traditional commenting (in the sense of creating remarks to support the code) but is closer related to good programming design principles.  This best practice approach  to coding involves using coding names that describe the action that is ta