Skip to main content

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 taking place. 
<?php 
 echo "hello"; 
 //this is a comment 
 echo " there"; 
 ?> 
These examples show that the variable or function name give a description of what is being performed.  Before abbreviating any code identifiers, make sure that they are descriptive enough so that others who would need to read the code would understand their meaning upon first glance.  Any time that needs to be devoted to deciphering a given naming convention is clearly a waste of time and should be considered over any advantage of minimizing the extra key strokes required by the initial programmers. 

InLine Commenting  

The most basic form of commenting is that which is referred to as inline or single line commenting.  This
type of commenting has its history in C++ and has become the standard approach to commenting for many
programmers (when they comment).  PHP supports this type of commenting by using two consecutive
forward slashes (//) preceding any comments added.


<html>

<body>



<?php

//This is a comment



/*

This is
a comment
block
*/
?>



</body>

</html>

With inline comments, there is no need to delimit the comments conclusion, the carriage return (\n) performs that action.

Comments

Popular posts from this blog

PHP INTRODUCTION

                     PHP  (recursive acronym for  PHP: Hypertext Preprocessor ) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. PHP stands for  P HP:  H ypertext  P reprocessor PHP is a server-side scripting language, like ASP PHP scripts are executed on the server PHP supports many databases (MySQL, Informix, Oracle, Sybase, Solid, PostgreSQL, Generic ODBC, etc.) PHP is an open source software PHP is free to download and use Why PHP? PHP runs on different platforms (Windows, Linux, Unix, etc.) PHP is compatible with almost all servers used today (Apache, IIS, etc.) PHP is FREE to download from the official PHP resource:  www.php.net PHP is easy to learn and runs efficiently on the server side What can PHP do? Anything. PHP is mainly focused on server-side scripting, so you can...

Storage Engine Breakdown

The following diagram represents a simplified view of the MySQL server and its interaction with the  storage engines. The following properties are storage engine dependant: • Storage Medium – Each table uses its own method of storing the data it contains. • Transactional Capabilities – Certain storage engines handle transactional processing which ensures that integrity of a database is maintained during the processing of multiple SQL statements.

SQL Joins

1. Login in to the mysql client using the login name and password provided by your instructor (if not already logged in). 2. View the existing databases that the MySQL Server is maintaining. SHOW DATABASES; 3. Utilize the photo_album database. USE photo_album; ---- If Need be, recreate the database and load the SQL data in that will be used for this lab CREATE DATABASE photo_album; SOURCE /tmp/photo_album.sql; 4. Query the database to display the active primary customer (email, first and last name) and all the associated active login names associated with that customer. SELECT customers.email_customer, customers.fname, customers.lname, logins.login_name  FROM customers, logins WHERE customers.email_customer = logins.email_customer  AND customers.active_customer = 'True'  AND logins.active_login = 'True';