הבלוג של ארתיום
בלוג על לינוקס, תוכנה חופשית, מוזיקה, סלסה, ומה לא!
קריאוּת הקוד
יש שתי שיטות מקובלת לתת שמות לפונקציות:
- לכתוב את המילים באותיות קטנות ולהפריד בין המילים ע"י סימן, '_' לדוגמה: "()my_cool_function"
- לכתוב תחילת כל מילה באות גדולה ולהדביק את כל המילים. לדגומה: "()MyCoolFunction"
אני נתקל הרבה בשתי השיטות האלו, וגם עד למלחמות קודש "מה יותר טוב?". אם עדיין נשארו לכם ספקות, תקראו את הציטוט הבא מויקיפדיה:
in_computer_programming_readability_refers_to_the_ease with_which_a_human_reader_can_comprehend_the_purpose flow_and_operation_of_a_machine_readable_section_of_source_code. readability_is_important_because_source_code must_inevitably_be_maintained_by_human_beings
InComputerProgrammingReadabilityRefersToTheEase WithWhichAHumanReaderCanComprehendThePurpose FlowAndOperationOfAMachineReadableSectionOfSourceCode. ReadabilityIsImportantBecauseSourceCode MustInevitablyBeMaintainedByHumanBeings
קראתם? איזה היה יותר קריא? כמה זמן לקח לכם לקרוא אותו? כשתכתבו את קטעי הקוד הבאים, תסיקו את המסקנות בעצמכם.
תגובות
יש הבדל בין פיסקה שלמה שמכילה הרבה מילים לשם של פונקציה שמכיל מקסימום 3 4 מילים.
הפסקא הראשונה היתה הרבה יותר קריאה, אבל עדיין בשביל כמה מילים זה לא באמת עקרוני...
ברור שמשפט שלם מקצין את העובדה, אבל עדיין במקרים רבים הרבה יותר ברור לקרוא את שם כשהוא מופרד ע"י קו-תחתון.
בהתחשב בעובדה שאדם קורא מילים שלמות ולא אותיות זה עושה הבדל.
קונבנצית ה- camelCase הוכנסה במקור לתכנות ע"מ להמנע מהקשת "־" שאינה נוחה. בתור מתכנת יוניקס לשעבר, שם השתמשו בעבר רק בשיטה הראשונה, אני מוכרח להגיד כי המעבר ל- camelCase עשה רק טוב לפרקי הידיים.
כמובן ששמעתי את הטיעון הזה המווווון...
אבל יש בעיה קטנה... גם על מנת לעשות UpperCase אתה צריך ללחוץ על shift כך שלכתוב כמהמקפיםתחתונייםזהלאכזהסיפור. באותה מידה אפשר לומר:
זה נכון שיותר נוח לרשום עם סימן _ זה נכון שזה יותר קריא. אבל תנסה להסביר את זה באקדמיה .
יש להם פורמט לא כתוב שאומר ששם פונקציה חייב להיות FooGoo לא משנה מה תגיד ...
בכל מקרה שימוש בפונציות עם הסבר על הפעולה במשפט איננו יעיל תמיד . אני אישית מעדיף שם קצר וקולע מאשר משפט שלם. לדוגמה : String_Addition במקום Addition_of_string_by_reffering_to_them_as_numbers
ובכל פונקציה לרשום הסבר. עם מישהוא קורא את הקוד שלי (מנחה) ולא מוכן לקרוא את ההערות בפונקציה הוא ממש לא במקצוע הנכון
הוסף תגובה:
חובה לאפשר JavaScript כדי להגיב.