أهمية وضع تعليقات في الكود

    في هذا المقال سنتعرف على التعليقات (Comments) و أهميتها بالنسبة للمبرمجين.


    ما هو التعليق في البرمجة؟

    هو نص غير برمجي يمكن إضافته الى الكود بأي لغة تريد سواء كانت الانجليزية أو العربية أو حتى غيرها من اللغات حتى تتمكن كمبرمج من توضيح المطلوب لفريق العمل أو لك مستقبلا. 


    ما هي أهمية التعليقات في البرمجة؟

    تكمن أهمية التعليقات بتسهيل قراءة الكود البرمجي وتنظيمه حتى يتمكن فريق العمل أو أي مبرمج آخر من فهم المطلوب من هذا الكود البرمجي بسهولة.


    ما هي الطرق التي تتم كتابة التعليقات بها؟

    في كل لغة برمجة يوجد طرق خاصة يمكنك فيها أن تضع تعليقات و في بعض اللغات يوجد أكثر من طريقة لكتابة التعليقات.

     

    طريقة إضافة تعليق في لغة JAVA

    في لغة جافا يوجد طريقتين لكتابة التعليقات:

    • إذا أردت كتابة تعليق يتألف من سطر واحد فقط يمكنك اضافة هذه العلامة // التي تسمى دبل سلاش (Double Slash) قبل البدء في كتابة التعليق.
    • إذا اردت كتابة تعليق يحتوي على أكثر من سطر يمكنك كتابة التعليق بين الرمز /* و الرمز */.

    مثال: طريقة إضافة تعليقات على كود Java.

    public class Test {
    
      public static void main (String [] args) {
        // رسالة ترحيبية بمناسبة انشاء هذه المدونة
        System.out.println("  اهلا وسهلا بكم في مدونة هرمش ");
        
        /* هذا الكود البرمجي تم انشاؤه لتوضيح اهمية التعليقات للقارئ الذي يزور هذه المدونة 
           قراءة ممتعة للجميع 
           تم تحريره في يوم الجمعة 
        */
        System.out.print("في يوم الجمعة اكثروا من الصلاة على النبي ");
      } 
    
    }
    


    طريقة إضافة تعليق في HTML

    بالنسبة لوضع التعليق في HTML بسيط للغاية, كل ما عليك فعله هو كتابة التعليق بداخل الرمز <-- --!> حتى و إن كان يتألف من أكثر من سطر.

    مثال: طريقة وضع التعليقات بداخل ملف HTML.

    <!DOCTYPE html>
    <!-- HTML code by Aqlaa -->
    <html>
    <body>
    <p>تم كتابة هذا الكود لتوضيح أهمية التعليقات</p>
    <!-- Don't forget to add comments -->
    </body>
    </html>
    


    طريقة إضافة تعليق في CSS

    بالنسبة للغة CSS فطريقة كتابة التعليق بسيطة أيضاً و لكنها تختلف عن طريقة كتابة التعليقات في HTML حتى لو كنت ستكتبها في ملف الـ HTML نفسه.

    لوضع تعليق في لغة CSS نكتب التعليق بين الرمز /* و الرمز */ حتى و إن كان يتألف من أكثر من سطر.

    مثال: طريقة إضافة تعليقات على كود CSS.

    p {
      color: blue; /* لون النص أزرق */
    }
    


    طريقة إضافة تعليق في SQL

    تختلف طريقة إضافة التعليقات من قاعدة بيانات لأخرى و لكن ليس جميعها يمكن إضافة التعليقات بها على سبيل المثال قواعد بيانات Access لا تسمح بإضافة التعليقات.

    في قواعد البيانات MySQL هنالك ثلاث طرق هي:

    • وضع الرمز -- و من بعدها تقوم بكتابة تعليق يتألف من سطر واحد.
    • وضع الرمز # و من بعدها تقوم بكتابة تعليق يتألف من سطر واحد.
    • وضع الرمز /* و من بعدها تقوم بكتابة التعليق و يمكن أن يتألف من عدة أسطر و في النهاية تضع الرمز */.

    مثال: طريقة إضافة تعليقات على كود SQL في قواعد بيانات MySQL.

    -- و من ثم إخترناها mysqlهنا قمنا بإنشاء قاعدة بيانات جديدة إسمها 
    CREATE DATABASE mysql;
    USE mysql; 
    
    /* users هنا قمنا بإنشاء جدول اسمه 
       يتألف من ثلاثة أعمدة 
    */ 
    CREATE TABLE users(
    id INT NOT NULL PRIMARY KEY AUTO_INCREMENT,
    first_name VARCHAR(50),
    last_name VARCHAR(50)
    );
    
    -- هنا قمنا بأضافة بيانات لخمسة مستخدمين
    INSERT INTO users VALUES(null, "Aqlaa", "AL-rshidi");
    INSERT INTO users VALUES(null,"Mhamad", "Harmush");
    INSERT INTO users VALUES (null, "Samar", "Ahmed");
    INSERT INTO users VALUES (null, "Sami", "Khalid");
    INSERT INTO users VALUES (null, "Amal", "Taher");
    

    يتضمن: Programming , SQL , CSS , HTML , Java

    آخر تحديث: 19-12-2021

    الكاتب

    عقلاء الرشيدي

    طالبة جامعية تخصص تقنية معلومات كاتبة مقالات في مدونة هرمش أسعى لنشر العلم والمعرفة…

    تعليقات 1

    أضف تعليق

    يجب تسجيل الدخول حتى تتمكن من إضافة تعليق أو رد.

    تقييم المقال

    لم تقم بتقييم المقال بعد!

    الدورات

    أدوات مساعدة

    الأقسام

    دورات
    مقالات أسئلة مشاريع كتب