PHP/הערות וסגנון

הסבר

כשתתחיל לכתוב תסריטים (scripts) מסובכים יותר, אתה תראה שאתה חייב לעשות את התסריט שיהיה ברור לעצמך ולאחרים בדיוק מה אתה עושה ולמה אתה עושה זאת. הערות ושמות "טובים" יוכלו לעזור לך לעשות תסריטים ברורים ומובנים. יש כמה סיבות למה לסבך את עצמך עם זה:

• כשאתה כותב תסריט במשך יותר משבוע, בזמן שתסיים, כבר לא תזכור מה עשית כשהתחלת, ולרוב אתה תצטרך לדעת.
• כל תסריט שתשתמש בו לעיתים קרובות תצטרך שכתוב במוקדם או במאוחר. שכתוב הרבה יותר קל(ובמקרים רבים, אפשרי) כשאתה כותב מה עשית.
• במוקדם או במאוחר - אנשים אחרים ירצו לדעת מה עשית יום ולילה לפני המחשב שלך! ובמוקדם או במאוחר, אתה תצטרך להראות למישהו את התסריט. ואתה רוצה את התסריט שלך נחמד ויפה, לא?

הערות

הערות הן דברים שהמפענח של PHP מדלג עליהם. כשהמפענח מגיע להערה, הוא פשוט הולך עד סופה מבלי לעשות דבר. PHP מאפשרת גם הערות בנות שורה אחת וגם הערות בנות מספר שורות.

הערות בשורה אחת

הערות בשורה אחת הן הערות שמתחילות איפה שאתה מתחיל אותן ונגמרות בסוף השורה. עם PHP, אתה יכול להשתמש בשני סימונים להתחלת הערה בבשורה אחת, // או #. סימונים אלו נועדו בעיקר כדי לומר לקורא מה אתה עושה בשורות הבאות. לדוגמא:

//Print the variable $message
echo $message;

חשוב להבין שהערות בשורה אחת לא "מעלימות" את כל השורה, אלא רק מאיפה שהן מתחילות, כך שאפשר להסביר לקורא מה בדיוק קורה בשורה מסויימת:

$message = ""; //This sets the variable $message to an empty string

החלק:

 $message = "";

יתבצע, אך שאר השורה לא.

הערות במספר שורות

הערות מסוג זה יוכלו להיות על כמה שורות שאתה רוצה, ויכולות להסביר מה פונקציה או מחלקה עושות. או רק להכיל שארוכות משורה אחת. לסימון של התחלת ההערה משתמשים ב-*/, ולסיום ההערה משתמשים ב-/*, לדוגמא:

/* This is a
   multiline comment
   And it will close
   When I tell it to.
 */

מתן שמות

מתן שמות למשתנים, לפונקציות ולמחלקות שלך בצורה נכונה היא דבר מאוד חשוב. אם אתה מגדיר אותם ככה:

$var1 = "PHP";
$var2 = 15;

המשתנים לא יגידו הרבה לאף אחד. אבל אם תעשה אותם כך:

$programming_language = "PHP";
$menu_items = 15;

זה יראה הרבה יותר ברור. אבל אל תגזים, programming_language, לדוגמא הוא לא שם טוב. הוא ארוך מדי, ויקח הרבה זמן להקליד אותו. שם טוב יותר יוכל להיות prog_lang, בגלל שהוא קצר יותר אך עדין מובן. כמו כן, אל תשכח להשתמש בהערות, כדי להסביר למה משמש כל משתנה.

$prog_lang = "PHP";  //The programming language used to write this script
$menu_items = 15;        //The maximum number of items allowed in your personal menu

מרווחים

PHP מתעלמת ממרווחים מיותרים. זאת אומרת, שאפילו שאתה יכול לכתוב את הקוד ככה:

 if($var == 1) {echo "Good";} else {echo "Bad";}

עדיף שיהיה כתוב ככה:

 if($var == 1)
 {
     echo "Good";
 }
 else
 {
     echo "Bad";
 }

מומלץ גם לעשות מרווח של שורה בין שני חלקים של הקוד. במקום

 $var = 1;
 echo "Welcome!\n";
 echo "How are you today?\n";
 echo "The answer: ";
 if($var == 1)
 {
   echo "Good";
 }
 else
 {
   echo "Bad";
 }

מומלץ שתכתוב:

 $var = 1;
 
 echo "Welcome!\n";
 echo "How are you today?\n";
 
 echo "The answer: ";
 if($var == 1)
 {
   echo "Good";
 }
 else
 {
   echo "Bad";
 }

והקורא יבין שבהתחלה הגדרת משתנה, לאחר מכן ברכת את המשתמש לשלום, ולבסוף בדקת את המשתנה.

הפרק הקודם: בסיס

הערות וסגנון

הפרק הבא: הערות