כיצד לשפר את הקריאה של קוד התוכנה שלך?
המטרה היא לתקשר את מה שהקוד עושה לקורא הבא, ולא להרשים אותו בכמה מעט שורות אתה יכול לקחת כדי לכתוב קוד.
בעת כתיבת קוד לתוכנית, קל לתקן את כל הבאגים ולבצע קומפילציה נכונה, אך להקל על אדם אחר לקרוא אותו קשה הרבה יותר. להלן מספר טיפים שיעזרו לך לשפר את קריאות הקוד שלך.
- 1אנשים ששומרים על קוד אינם מעולם בקיאים כמו המחבר המקורי. הם עשויים להיות בעלי כישורי תכנות גרועים יותר והם יידעו פחות על הפרויקט. זה האדם שאתה כותב עבורו את התוכנית. אתה רוצה שהקוד יהיה קל לאדם הזה.
- 2רק בגלל שתכונת שפה זמינה בשפה, זה לא אומר שאתה צריך להשתמש בה. המטרה היא לתקשר את מה שהקוד עושה לקורא הבא, ולא להרשים אותו בכמה מעט שורות אתה יכול לקחת כדי לכתוב קוד.
- 3לעיתים קרובות קשה לעקוב אחר אלגוריתם. אבל לעתים קרובות זה מתפרסם איפשהו. הצב את ה- URI של התיעוד לאלגוריתם בסעיף ההערות עבור הקוד. אם ה- URI מצביע על מיקום ארעי, העתק את המידע לאנשהו איפה שמנהל הקוד יכול למצוא אותו.
- 4התייחס לתקן הקידוד בכותרת הקובץ. ספק קובץ במידת האפשר שכלים יכולים לפתוח כדי לשלב את ההגדרות הנכונות. כדוגמה Eclipse ברירת המחדל היא להשתמש בכרטיסיות, אך הכרטיסיות מוצגות באופן שונה בעורכי טקסט שונים. אולי עדיף להשתמש במרחב לבן במקום בכרטיסיות, אך יש לו קובץ המספק את ההגדרות המתאימות לפרויקט.
זה גורם לכך שברור שנתח קוד נפרד מזה אחר. - 5השתמש במרחב לבן. דלג על שורות בין קוד שעושה דברים שונים, והשתמש ברווחים אחרי נקודה-פסיק ופסיקים. זה יגרום לקוד שלך להראות נקי יותר וקל יותר לקריאה.
- 6כניסה בתוך סוגריים מתולתלים. זה גורם לכך שברור שנתח קוד נפרד מזה אחר. זה יכול לעזור בעת כתיבת שיטה ארוכה. כניסה פנימה אם הצהרות ולולאות יקלו על הקריאה. טכניקה זו נקראת קינון, כלומר היא מראה שגוש קוד "מקונן" בתוך נתח קוד אחר, ומאפשר לקורא לעקוב בקלות אחר דפוס הקינון.
- 7כתוב הערות תיאוריות. נניח שהאדם שקורא את הקוד שלך לא יודע כלום על מה הוא אמור לעשות. התגובות שלך צריכות להסביר כל צעד ושעל. כל של אלגוריתמים מתקדמים, מבלבל, או מסובך שלך יוער גם. כמו כן, נסו לתאר איזו מטרה לקוד יש. לדוגמא, במקום לכתוב "הוסף אחד למשתנה", אמור מדוע זה חשוב בקוד, שכן כל אחד יכול לראות שהוא מגדיל את המשתנה, למשל "הגדל את מספר כניסות העמודים ב -1".
- 8הפוך את הקוד שלך ל"תיעודי עצמי "על ידי יצירת שמות עצמים תיאוריים המתארים את מטרותיהם. אובייקטים צריכים להתייחס לתחום הבעיה או לחפצי תוכנה סטנדרטיים. רשימה היא רשימה. ייתכן שיהיה עליך ליצור רשימת לקוחות שתסווג או יישם רשימה. משתנים ופרמטרים של פונקציות צריכים לכלול שמות תיאוריים.
- 9כלול את המחבר המקורי ואת השומר הנוכחי של הקוד בתגובה הראשונית של הקובץ. זה אומר לאנשים שאליהם ללכת לשרת את הקוד.
- 10הגיב לעיתים קרובות. כתוב הערות כדי לציין את כוונתך. מעבר להגיב על הקוד שלך יוביל למישהו שימחק את התגובות שלך.
כלול את המחבר המקורי ואת השומר הנוכחי של הקוד בתגובה הראשונית של הקובץ.
- הקלה על הקריאה של הקוד שלך תסייע לך גם באגים בתכנית משלך ותקל על עצמך.
- משתנים קבועים צריכים להיות באותיות רישיות, כאשר מילים מופרדות באמצעות קו תחתון. משתנים רגילים צריכים להיות באותיות רישיות של כל מילה באותיות רישיות, תוך השמטת קו תחתון.
- הוסף רווחים לבנים אם הם מורשים.
- אם אתה רוצה להגיב על נתח גדול של טקסט, השתמש ב "/ *" כדי להתחיל בתגובה וב- "* /" כדי לסיים אותה. לאחר מכן, אינך צריך לכתוב "//" בכל שורה. (שימו לב כי הערות עשויות להיות שונות בשפות אחרות)
- מצא את סגנון כתיבת הקוד שלך. ישנם מגוון סגנונות שבהם אתה יכול להשתמש, כגון הדוגמאות הבאות: myVariable, MyVariable, myvariable, MYVARIABLE, My_Variable, MY_VARIABLE, my_variable, my_Variable, My_Variable, ועוד. הקפד להקצות כל סגנון לסוג ספציפי כגון MY_VARIABLE עבור משתנים קבועים ו- myVariable עבור משתנים רגילים. רק וודא שאתה נשאר עקבי באמצעות סגנון. אתה לא רוצה שיהיה לך משתנים קבועים myVariable ו- MY_VARIABLE.
