יש בעיקרון שלושה דברים שניתן לעשות כדי לכתוב קוד ברור ב HTML-CSS-JavaScript.
להקפיד על קריאות
בפיתוח תוכנה, המונח קריאות (באנגלית: Readability) משמש לתאר כמה קל למפתח תוכנה או לצוות פיתוח תוכנה לקרוא ולהבין קובץ קוד מקור של תוכנה.
קריאות מושגת דרך מאפיינים אלה, למשל:
- הלקסיקון של שפת מחשב מכיל תוים שמפתחי התוכנה מכירים היטב
- התחביר של שפת מחשב סדור מאד
- רכיבי קוד מקור התוכנה כגון משתנים ופרוצדורות עברו שיום (naming) טוב
- רכיבי קוד מקור התוכנה עברו קינון טוב
ייתכנו עוד עקרונות מוגדרים, כגון הקפדה על סטנדרטיי קידוד (coding standards) של פריימוורק קהילתי נפוץ
שימוש בהערות קוד
הערת קוד היא הערה בשפת תקשורת כללית העטופה בתחביר של שפת מחשב מסוימת.
הערת קוד נכתבת לעתים קרובות בתוך תחום קוד במטרה לבאר חלקי קוד מסוימים (לרוב מורכבים מאד).
מפתחי תוכנה רבים מעידים שלפעמים אם הם מסתכלים על קוד מסוים שהם כתבו חודש או שבוע ואף לפעמים יום לאחר מכן הם לא בדיוק זוכרים מה הם עשו ומה הם ניסו להשיג בכך או לא נזכרים בכך במהירות מספקת אך הערות עוזרות להם למנוע תופעה זו.
באופן כללי, לכל שפת מחשב יש את התחביר שלה להוספת הערה; חלק משפות המחשב מאפשרות הערה רק בשורה בודדה וחלק מאפשרות הערה רבת שורות.
דוגמה
בשפת JavaScript ניתן להוסיף הערה חד-שורתית בתחביר זה:
// This is a single-line comment
וכן בשפת JavaScript ניתן גם להוסיף הערה רב-שורתית בתחביר זה:
*/ This is a multi-line comment */
- אני אישית נוטה לתחום הערת קוד חד שורתית עם סימן נקודה פסיק (
;) כי זה דומה אסתטית לתחימה של קוד חד שורתי בשפת JavaScript עמה אני לעתים מקודד.
גישה מודולרית בקידוד
המונח מודולריות ראוי למאמר עצמאי אבל בהקשר זה (HTML-CSS-JavaScript) העיקר הוא פיצול קוד המקור לקבצים שונים המבצעים כל אחד פעולה אחרת, ככל שהדבר אפשרי. בשפת HTML ניתן להשיג זאת דרך כתיבת הקוד בתוך קבצי PHP הכוללים include לקבצים אחרים. בקבצי CSS ניתן להשיג זאת דרך מתן שמות שונים לקבצים לפי הקשר (כגון header.css, fotter.css וכדומה) וכן בקבצי JavaScript מריצים סקריפטים שונים לפי תנאי מוגדר היטב.
תגובה