יום שבת, יולי 16, 2011

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

למרות שהתיעוד של הקרנל ממליץ להתרחק מtypedefים ולא להשתמש יותר מדי בשמות ארוכים מדי,  הדרך הבאה עזרה לי בדיבוג ואיתור צרות (טוב נו הדברים שלומדים מחברות שעובדים בהם ... ).


  1. פונקציה תהיה באורך של מסך vim אחד.
  2. לכל פונקציה קיים test case  - עבור sanity check.
  3. כל פונקציה מבצעת פעולה לוגית מינימלית :
    1. אם אתה לא בטוח כך אדם שלא יודע מה הקוד אמור לעשות תן לו לקרוא אם יש ולו שאלה אחת זה יותר מדי.
  4. כאשר יש שימוש ב goto שמור את המקום ממנו הגיע המעבר , כאשר יש שימוש בדגל debug הצג זאת.
  5. בעליית המודול תמיד ירוצו כל ה sanity checks שאפשר לבצע על המודול.
  6. בהדפסות תוסיף שם קובץ ושורה.
  7. השתמש בשם המתקבל מהמודול ולא בשם שקיים כרגע.
  8. לעולם אין הכרזה על יותר ממשתנה אחד בשורה.
  9. יש הפרדה בשם בפרמטרים שניכנסים לפונקציה  מאשר פרמטרים שקיימים בתוך הפונקציה.
  10. שם פונקציה מסביר הייטב מה הפונקציה עושה.
  11. התיעוד מסביר למה הפונקציה עושה את מה שהיא עושה ולא מה היא עושה.
  12. שימוש Hungarian apps
  13. enum ו #define  הם חבריך הטובים ביותר אבל אל תמציא שפה משלך.

אם פעם הסוג צריך להיות uint ו פעם ulong להגדיר את הסוג כtypedef.
אם אנו עובדים על null terminated string להשתמש ב '0\' במקום באפס.


תמיד תחזיק תסריט שבודק את החוקים שלך.

אין תגובות:

הוסף רשומת תגובה