PHP is a very versatile language, allowing for programmers to make applications according to their various tastes or styles. But one thing all programmers should maintain is the ability to comment effectively. In essence, commenting can save hours of time perusing code months down the road- and is often required by employers.
Comments aren't parsed by the PHP engine, so they are only visible to those who are viewing the original source code of the file. This is great for documenting what each code block does, all while keeping the casual visitor to a website oblivious to the extra comments present on the application they are using.
It's often a better idea to use PHP comments in place of others such as HTML comments, since PHP comments will never be seen by the end user if the script is running correctly. This simple fact will help safeguard against others stealing source code, ideas, or principles from an application.
Comments are created with three different calls. For comments that span two or more lines, we have to use "/*" and "*/" - and "#" or "//" for single line comments. Comments in PHP can actually be placed directly after real PHP code, above it, or below it. This leaves a lot of creativity in how developers document their code according to their style and tastes.
Unbeknown to most, PHP comments can also be used for more practical scenarios, such as troubleshooting. Expert programmers will find they have a problem with their application, and comment out different blocks of code to see what is causing the error. While it is usually in new code blocks, this method will indeed show that sometimes the problem is due to program code interacting wrong, which can in effect mean the problem is anywhere in the application.
Commenting in PHP is also great to use in selection structures, since PHP has long been known as a hard to scale language. Once files start getting big, it can be dizzying to try and remember which loops and selection structures go where, and what they do. By commenting out every closing bracket, and what it is in relation to, the problem is easily fixed. This is often mandatory for programmers who work for employers.
Closing Comments
PHP Comments are quite handy as we can see, more so than most would think. From troubleshooting to simple documentation, the three methods of commenting have a lot of use to the proper programmer. For more information on comments in PHP, and in other languages, check out more books, articles, and magazines for a more detailed guide in using them effectively.
Comments aren't parsed by the PHP engine, so they are only visible to those who are viewing the original source code of the file. This is great for documenting what each code block does, all while keeping the casual visitor to a website oblivious to the extra comments present on the application they are using.
It's often a better idea to use PHP comments in place of others such as HTML comments, since PHP comments will never be seen by the end user if the script is running correctly. This simple fact will help safeguard against others stealing source code, ideas, or principles from an application.
Comments are created with three different calls. For comments that span two or more lines, we have to use "/*" and "*/" - and "#" or "//" for single line comments. Comments in PHP can actually be placed directly after real PHP code, above it, or below it. This leaves a lot of creativity in how developers document their code according to their style and tastes.
Unbeknown to most, PHP comments can also be used for more practical scenarios, such as troubleshooting. Expert programmers will find they have a problem with their application, and comment out different blocks of code to see what is causing the error. While it is usually in new code blocks, this method will indeed show that sometimes the problem is due to program code interacting wrong, which can in effect mean the problem is anywhere in the application.
Commenting in PHP is also great to use in selection structures, since PHP has long been known as a hard to scale language. Once files start getting big, it can be dizzying to try and remember which loops and selection structures go where, and what they do. By commenting out every closing bracket, and what it is in relation to, the problem is easily fixed. This is often mandatory for programmers who work for employers.
Closing Comments
PHP Comments are quite handy as we can see, more so than most would think. From troubleshooting to simple documentation, the three methods of commenting have a lot of use to the proper programmer. For more information on comments in PHP, and in other languages, check out more books, articles, and magazines for a more detailed guide in using them effectively.
Posts
No comments:
Post a Comment