לימוד PHP » הוספת הערות לקוד PHP

הוספת הערות לקוד PHP

נכתב ע"י יוחאי ירמיהו

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

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

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

הוספת הערה ב-PHP לשורה אחת

הדרך הראשונה להוסיף הערה באמצעות קוד PHP היא על ידי שימוש בסימן # או שימוש בסימן //. שתי ההערות האלו מאפשרות להוסיף הערה רק לשורה אחת בעמוד.

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

// הערה של שורה אחת בקוד php

# הערה נוספת של שורה אחת בקוד php

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

// הערה של שורה אחת בקוד 
השורה שמופיעה כאן מתחת כבר מציגה קוד פעיל

עוד נקודה חשובה שכדאי להכיר היא שאפשר להוסיף שורת הערה לסיום של קוד שהרצנו ולהכניס את ההערה לצד הקוד שהרצנו באמצעות PHP. במקרה הבא כל מה שנמצא בשורה לפני ההערה הוא קוד פעיל והשאר יהיה קוד לא פעיל.

<?php 
    echo "PHP Text"; // כאן אפשר להכניס הערה 
?>

הוספת הערה ב-PHP שתשפיע על מספר שורות

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

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

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

<?php 
    /*
        הקוד הבא מאפשר לנו להכניס הערה יותר מורכבת
        וכל מה שמופיע בין התווים מתחת ומעל ייחשב כהערה
    */
?>

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

<?php 
    /* ----------------------------------------------------------------------------
       הוספת הערת קוד בולטת למסמך
    ---------------------------------------------------------------------------- */ 
?>

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

<?php 
    // ----------------------------------------------------------------------------
    // הוספת הערת קוד בולטת למסמך
    // ----------------------------------------------------------------------------
?>

הוספת הערות לקוד PHP

הוספת הערה ב-PHP לשורה אחת

הוספת הערה ב-PHP שתשפיע על מספר שורות

מדריכי PHP