• אודות
  • כנסים ואירועים
  • צור קשר
  • הצטרפות לניוזלטר
  • TapeOut Magazine
  • ChipEx
  • סיליקון קלאב
  • Jobs
מבית
EN
Tech News, Magazine & Review WordPress Theme 2017
  • עיקר החדשות
    לוגו איגוד חברות השבבים -SIA

    הדוח השנתי של SIA: התאוששות הענף וחשש מהמכסים

    קיימות בתעשיית הטכנולוגיה. אילוסטרציה: depositphotos.com

    דו"ח חדש: ייצור שבבים ומרכזי נתונים חייבים לעבור לקיימות – לפני שהרגולציה תכפה זאת

    מיזוג MIPS לתוך גלובל פאונדריז. צילום יחצ גלובל פאונדריז.

    GlobalFoundries רוכשת את MIPS: מהפך בתעשיית שבבי ה־RISC

    שגשוג הכלכלה הבריטית תלוי בתעשיית השבבים. אילוסטרציה: depositphotos.com

    שבבים כדרכון לגוש הG7: טכנולוגיית השבבים כבסיס לכוח גיאופוליטי בבריטניה

    מכרה נחושת בסין. אילוסטרציה: depositphotos.com

    PwC: משבר האקלים מאיים על שליש מאספקת השבבים העולמית

    סינגפור משיקה מרכז לאומי לטכנולוגיית גליום ניטריד

    סינגפור משיקה מרכז לאומי לטכנולוגיית גליום ניטריד

    Trending Tags

    • בישראל
      מערכת להחזרת שבבים שיוצרו על הירח לכדור הארץ. איור: אינטואיטיב מאשינס

      דרור בין: "הרחבת אנבידיה בצפון – הבעת אמון עמוקה בהייטק הישראלי"

      פרופ' אמנון שעשוע בהרצאה בכנס CES 2023. צילום: אבי בליזובסקי

      אינטל מוכרת מניות של מובילאיי בהיקף של 900 מיליון דולר תרד מ-88% ל-80% בעלות

      הלוויין דרור 1. איור: התעשייה האווירית

      שיגור מוצלח ללוויין הישראלי "דרור 1": צעד אסטרטגי לחיזוק ריבונות התקשורת של ישראל

      מנכ"ל אנבידיה ג'נסן הואנג "נכנס" לתוך המטהוורס. צילום יחצ

      אנבידיה חצתה את רף ה-4 טריליון דולר ובונה את עתיד ה-AI מישראל

      אנטנת לוויינים של גילת. צילום יחצ

      גילת קבלה הזמנות בסכום העולה על 22 מיליון דולר ממפעילי לוויינים מובילים

      לוגו טאואר. צילום יחצ

      טאואר הישראלית וטאטא ההודית מתחרות על שדרוג מפעל השבבים במוהאלי

      Trending Tags

      • מדורים
        • אוטומוטיב
        • בינה מלאכותית (AI/ML)
        • בטחון, תעופה וחלל
        • ‫טכנולוגיות ירוקות‬
        • ‫יצור (‪(FABs‬‬
        • ‫צב"ד‬
        • ‫שבבים‬
        • ‫רכיבים‬ (IOT)
        • ‫תוכנות משובצות‬
        • ‫תכנון אלק' (‪(EDA‬‬
        • תקשורת מהירה
        • ‫‪FPGA‬‬
        • ‫ ‪וזכרונות IPs‬‬
      • מאמרים ומחקרים
      • צ'יפסים
      • Chiportal Index
        • Search By Category
        • Search By ABC
      No Result
      View All Result
      Chiportal
      • עיקר החדשות
        לוגו איגוד חברות השבבים -SIA

        הדוח השנתי של SIA: התאוששות הענף וחשש מהמכסים

        קיימות בתעשיית הטכנולוגיה. אילוסטרציה: depositphotos.com

        דו"ח חדש: ייצור שבבים ומרכזי נתונים חייבים לעבור לקיימות – לפני שהרגולציה תכפה זאת

        מיזוג MIPS לתוך גלובל פאונדריז. צילום יחצ גלובל פאונדריז.

        GlobalFoundries רוכשת את MIPS: מהפך בתעשיית שבבי ה־RISC

        שגשוג הכלכלה הבריטית תלוי בתעשיית השבבים. אילוסטרציה: depositphotos.com

        שבבים כדרכון לגוש הG7: טכנולוגיית השבבים כבסיס לכוח גיאופוליטי בבריטניה

        מכרה נחושת בסין. אילוסטרציה: depositphotos.com

        PwC: משבר האקלים מאיים על שליש מאספקת השבבים העולמית

        סינגפור משיקה מרכז לאומי לטכנולוגיית גליום ניטריד

        סינגפור משיקה מרכז לאומי לטכנולוגיית גליום ניטריד

        Trending Tags

        • בישראל
          מערכת להחזרת שבבים שיוצרו על הירח לכדור הארץ. איור: אינטואיטיב מאשינס

          דרור בין: "הרחבת אנבידיה בצפון – הבעת אמון עמוקה בהייטק הישראלי"

          פרופ' אמנון שעשוע בהרצאה בכנס CES 2023. צילום: אבי בליזובסקי

          אינטל מוכרת מניות של מובילאיי בהיקף של 900 מיליון דולר תרד מ-88% ל-80% בעלות

          הלוויין דרור 1. איור: התעשייה האווירית

          שיגור מוצלח ללוויין הישראלי "דרור 1": צעד אסטרטגי לחיזוק ריבונות התקשורת של ישראל

          מנכ"ל אנבידיה ג'נסן הואנג "נכנס" לתוך המטהוורס. צילום יחצ

          אנבידיה חצתה את רף ה-4 טריליון דולר ובונה את עתיד ה-AI מישראל

          אנטנת לוויינים של גילת. צילום יחצ

          גילת קבלה הזמנות בסכום העולה על 22 מיליון דולר ממפעילי לוויינים מובילים

          לוגו טאואר. צילום יחצ

          טאואר הישראלית וטאטא ההודית מתחרות על שדרוג מפעל השבבים במוהאלי

          Trending Tags

          • מדורים
            • אוטומוטיב
            • בינה מלאכותית (AI/ML)
            • בטחון, תעופה וחלל
            • ‫טכנולוגיות ירוקות‬
            • ‫יצור (‪(FABs‬‬
            • ‫צב"ד‬
            • ‫שבבים‬
            • ‫רכיבים‬ (IOT)
            • ‫תוכנות משובצות‬
            • ‫תכנון אלק' (‪(EDA‬‬
            • תקשורת מהירה
            • ‫‪FPGA‬‬
            • ‫ ‪וזכרונות IPs‬‬
          • מאמרים ומחקרים
          • צ'יפסים
          • Chiportal Index
            • Search By Category
            • Search By ABC
          No Result
          View All Result
          Chiportal
          No Result
          View All Result

          בית דפי האתר ושונות בלוגים הבלוגים של Chiportal How much comment does your code need?

          How much comment does your code need?

          מאת Dr. Olivier Coudert
          14 מרץ 2015
          in הבלוגים של Chiportal
          israel_preker1
          Share on FacebookShare on TwitterLinkedinWhastsapp

          How much comment does your code need?

          Dr. Olivier Coudert

          underline-blog-409

          Writing code is not simply about putting language constructs together. It’s about architecture, complexity analysis, tradeoffs, testing, measuring performances, etc. And it’s about making sure that developers (other people as well as the original author) can later read and understand that code, for bug fixing or enhancement. This is where comments come into play (not to be confused with documentation!).

          How much comment does your code need?


          Dr. Olivier Coudert

            underline-blog-409

            Writing code is not simply about putting language constructs together. It’s about architecture, complexity analysis, tradeoffs, testing, measuring performances, etc. And it’s about making sure that developers (other people as well as the original author) can later read and understand that code, for bug fixing or enhancement. This is where comments come into play (not to be confused with documentation!).

            Developers put comments into their code to explain what it does, how it does it, to spell out assumptions, to warn about exceptions, etc. Commenting code is considered as a serious commodity in the world of code quality. People have been measuring the ratio comments/code, and came out with empirical rules. It is widely recommended that about 30% of the source code be comments.

            So what is a good ratio? Is 30% of comment sufficient? Should it be more, or is 15% OK? And why?

            I label comments as follows:

            1. Redundant: the comment states the obvious and does not bring any information. It is a waste of space.

            2. Obsolete: the code changed, but the comment was not updated. It is irrelevant at best, misleading and confusing at worst.

            3. Incorrect: the comment only reflects the author’s confusion. It is as misleading as (2).

            4. Informative: none of the above.

            In my experience most of the comments fall into category 1: a pollution that does not bring any information that the actual source code does not already provide. Category 2 is quite common too: as the code evolves, the comments do not always keep up. How often do I see useful comments?

            • If a comment is necessary to explain what a function does or what a variable represents, I argue that the name of the entity (function, class, type, data member, variable, etc) should carry that meaning.

            • If the comment is about an assumption, an invariants, or an exception, then some extra code guarded with an assert() is a non-ambiguous statement, better than any explanation.

            Code should be as self-explanatory as possible. The API, the name of the constructs, the architecture, the assertions, the exception handling: all those aspects bring so much more information and intend than a few sentences in English (replace with your favorite dialect used to write comments). Natural languages are inherently ambiguous; they cannot be trusted to convey formal or logical assessments.

            I find a comment to be valuable only in the following cases:

            • To refer to a specific, non-trivial algorithm.

            • To leave a note for future enhancement.

            • To make a joke.

            So what is the adequate percentage of comment? If your code reads like a perfect prose, then you should have 0% comment. Practically, it is a few percent (5% is more than enough), leaving notes, references, or clarifications on hardcore algorithms. Anything more is pollution, or the symptom of a code that can be written better.

            {loadposition content-related}

          Dr. Olivier Coudert

          Dr. Olivier Coudert

          נוספים מאמרים

          Shlomo_Gradman_2
          בינה מלאכותית (AI/ML)

          האם הגענו לשלב בו מחשב יכול לנצח את המוח האנושי?

          Shlomo_Gradman_2
          הבלוגים של Chiportal

          ענקית השבבים החדשה

          ADI_KATAV
          הבלוגים של Chiportal

          היכן נפתח משרד פיתוח ושיווק כאשר פנינו לסין ושווקי אסיה?

          Shlomo_Gradman_2
          הבלוגים של Chiportal

          מה שהיה הוא לא מה שיהיה – גם בשוק האלקטרוניקה

          הפוסט הבא
          Klaus_Oestermann_Citrix_1

          Citrix משיקה דור חדש של בקר ה-NetScaler המיועד לספקיות שירותי תקשורת

          כתיבת תגובה לבטל

          האימייל לא יוצג באתר. שדות החובה מסומנים *

          • הידיעות הנקראות ביותר
          • מאמרים פופולאריים

          הידיעות הנקראות ביותר

          • טאואר הישראלית וטאטא ההודית מתחרות על שדרוג מפעל…
          • אלוט חתמה על הסכם משמעותי עם מפעיל תקשורת גדול באירופה
          • סינגפור משיקה מרכז לאומי לטכנולוגיית גליום ניטריד
          • GlobalFoundries רוכשת את MIPS: מהפך בתעשיית שבבי ה־RISC
          • PwC: משבר האקלים מאיים על שליש מאספקת השבבים העולמית

          מאמרים פופולאריים

          • היתרון הישראלי בסכסוך האיראני – לוחמה מדויקת…
          • ענבר דג – דג נדיר בתעשיית השבבים
          • מסטארטאפ ניישן לסמיקונדקטור ניישן: כיצד הפכה ישראל…
          • מקרה קלרנה : האם הרומן עם הבינה מלאכותית הסתיים בבגידה?
          • אתגרי תכנון שבבים ב – 1.8 ננומטר

          השותפים שלנו

          לוגו TSMC
          לוגו TSMC

          לחצו למשרות פנויות בהייטק

          כנסים ואירועים

          כנסים ואירועים

          כנס ChipEx2025 יערך ב-13-14 במאי, 2025. הכנס מיועד לכל העוסקים בתעשיית הסמיקונדקטור  כולל מהנדסים, מומחים מקצועיים ובכירים.

          לחץ לפרטים

          הרשמה לניוזלטר של ChiPortal

          הצטרפו לרשימת הדיוור שלנו


            • פרסם אצלנו
            • עיקר החדשות
            • הצטרפות לניוזלטר
            • בישראל
            • צור קשר
            • צ'יפסים
            • Chiportal Index
            • TapeOut Magazine
            • אודות
            • מאמרים ומחקרים
            • תנאי שימוש
            • כנסים
            • אוטומוטיב
            • בינה מלאכותית
            • בטחון, תעופה וחלל
            • ‫טכנולוגיות ירוקות‬
            • ‫יצור (‪(FABs‬‬
            • ‫צב"ד‬
            • ‫רכיבים‬ (IOT)
            • ‫שבבים‬
            • ‫תוכנות משובצות‬
            • ‫תכנון אלק' (‪(EDA‬‬
            • ‫‪FPGA‬‬
            • ‫ ‪וזכרונות IPs‬‬

            השותפים שלנו

            כל הזכויות שמורות Chiportal (c) 2010 תנאי שימוש ומדיניות פרטיות

            דרונט דיגיטל - בניית אתרים, בניית אתרי וורדפרס, בניית אתרי סחר, חנות אינטרנטית, פיתוח אתרים

            No Result
            View All Result
            • עיקר החדשות
            • בישראל
            • מדורים
              • אוטומוטיב
              • בינה מלאכותית (AI/ML)
              • בטחון, תעופה וחלל
              • ‫טכנולוגיות ירוקות‬
              • ‫יצור (‪(FABs‬‬
              • ‫צב"ד‬
              • ‫שבבים‬
              • ‫רכיבים‬ (IoT)
              • ‫תוכנות משובצות‬
              • ‫תכנון אלק' (‪(EDA‬‬
              • ‫‪FPGA‬‬
              • ‫ ‪וזכרונות IPs‬‬
              • תקשורת מהירה
            • מאמרים ומחקרים
            • צ'יפסים
            • כנסים
            • Chiportal Index
              • אינדקס חברות – קטגוריות
              • אינדקס חברות A-Z
            • אודות
            • הצטרפות לניוזלטר
            • TapeOut Magazine
            • צור קשר
            • ChipEx
            • סיליקון קלאב

            כל הזכויות שמורות Chiportal (c) 2010 תנאי שימוש ומדיניות פרטיות

            דרונט דיגיטל - בניית אתרים, בניית אתרי וורדפרס, בניית אתרי סחר, חנות אינטרנטית, פיתוח אתרים

            דילוג לתוכן
            פתח סרגל נגישות כלי נגישות

            כלי נגישות

            • הגדל טקסטהגדל טקסט
            • הקטן טקסטהקטן טקסט
            • גווני אפורגווני אפור
            • ניגודיות גבוההניגודיות גבוהה
            • ניגודיות הפוכהניגודיות הפוכה
            • רקע בהיררקע בהיר
            • הדגשת קישוריםהדגשת קישורים
            • פונט קריאפונט קריא
            • איפוס איפוס