تضمين التعليقات

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

 

1 – تعليق في سطر واحد :

 

حيث ان اي شيئ بعد الشرطتين المائلتين // يتم التعامل معه على انه تعليق توضيحي وليس كود برمجي وبالتالي لا ينفذ وينتهي التعليق بنهاية السطر.


// comment

2 – تعليق متعدد الاسطر :

 

ربما ترغب بكتابة تعليق طويل نوعا ما تشرح فيه شيء معين يخص الكود عندها ستحتاج لاكثر من سطر , لهذا الغرض استخدم الشكل /* */ المخصص للتعليقات متعددة الاسطر .

 


/*

Multi line

comment

*/

 

يجب ان نلاحظ الفرق بين طريقة وضع التعليقات في HTML وطريقة وضعها في جافا سكربت ..

 مثال :

لنضع بعض التعليقات على الكود البرمجي التالي :

<!DOCTYPE html>
 
<html>
 
<head>
 
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
 
<title>Ways To Insert Javascript And Comments</title>
 
<!-- في هذا المستند سنبين كيفية وضع التعليقات -->
 
<script type="text/javascript" src="filename.js"></script>
 
<script type="text/javascript">                // the open tag for javascript
 
Document.write("Using Comments In Javascript");      //write method
 
</script><!-- close tag for javascript -->
 
</head>
 
<body>
 
<script type="text/javascript">
 
/*
 
Multi line comment
 
This Javascript code is inside
 
the body section
 
*/
 
</script>
 
</body>
 
</html>

 

كود جافا سكربت :

 
إن أي لغة برمجة هي عبارة عن مجموعة من التعليمات تعطى للحاسوب لتنفيذها وتنقسم هذه التعليمات الى ما يسمى بالامر البرمجي حيث ان كل أمر يعتبر تعليمة واحدة .. وكود جافا سكربت هو الكتلة البرمجية المكتوبة داخل العنصر script اي كل الاسطر المكتوبة بين وسمي الفتح والاغلاق …

 

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

يحتوي كود جافا سكربت على توابع وجمل شرطية وحلقات ومصفوفات ومتغيرات وبيانات نصية وعددية وتعليقات وغيرها .. تجتمع معاً لتؤدي الغرض المطلوب من البرنامج :

<!DOCTYPE html>
 
<html>
 
<head>
 
<meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
 
<title>StopWatch</title>
 
<script type="text/javascript">            // بداية الكود البرمجي
 
var y = 0,z = 0,w = 0;                                // الاعلان عن المتغيرات
 
function clock() {                                     // تابع اول
 
y++;
 
if(y==60){z++;y=0};                                  // جملة شرطية
 
if(z==60){w++;z=0};
 
x=document.getElementById("tt");    // امر برمجي للوصول لعنصر محدد
 
x.innerHTML = w+":"+z+" "+y;            // امر برمجي اخر لارجاع القيم
 
t = setTimeout("clock()",1000);
 
}
 
function stop() {                                      // تابع ثاني
 
clearTimeout(t);
 
}
 
</script>
 
</head>
 
<body>
 
<div id="tt">0</div>
 
<a href="#" onclick="clock();">Start</a> <!--استدعاء التابع الاول -->
 
<a href="#" onclick="stop();">Stop</a>    <!-- استدعاء التابع الثاني -->
 
</body>
 
</html>