PHP/הערות וסגנון: הבדלים בין גרסאות בדף

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

 

//Print the variable $message

echo $message;

</pre>

 

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

 

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

</pre>

 

החלק:

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

 

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

 

/* This is a

multiline comment

*/

</pre>

 

==מתן שמות==

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

$var2 = 15;</pre>

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

$menu_items = 15;</pre>

 

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

$menu_items = 15; //The maximum number of items allowed in your personal menu

</pre>

 

==מרווחים==

זאת אומרת, שאפילו שאתה יכול לכתוב את הקוד ככה:

 

 

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

 

if($var == 1)

{

echo "Bad";

}</pre>

 

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

$var = 1;

echo "Welcome!\n";

}

</pre>

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

$var = 1;

}

</pre>

 

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

[[category:PHP]]