سيكون التوثيق جانبًا مُهمًّا من نشاطاتك البرمجيَّة. التوثيق هو كيفيّة شرحك لكودك للمُبرمجين الآخرين. يَتُم التوثيق عبر التعليقات التي تُضاف إلى الكود. يُمكنك عبر التعليقات إعلام المبرمجين الآخرين بنوع البيانات الذي يتعامل معه كودك والمُخرجات التي يولّدها. يتجاهل عادةً المُصرِّف كل الأكواد المُعلَّقة. تختلف طريقة التعليق بين اللغات، فيُستخدَم الرمز # مثلًا للتعليق في بايثون.
# program snippet to compute fibonacci of N numbers
توجد في لغات الجافا وسي وسي++ تعليقات للأسطر الواحدة تُكتَب مسبوقةً بالرمز // (كتلك في بايثون المسبوقة بالرمز #). توجد كذلك تعليقات متعددة السطور مثل /* ... */. يُمكنك قراءة المزيد عن التعليقات في اللغة التي اخترت تعلّمها في توثيقها.
المسافات البيضاء والجدولات
تُمثِّل هذه المسافات بين الأكواد، سواءً كانت المسافات الناتجة عن ضغط المسطرة (مفتاح المسافة) أو مفتاح الجدولة.
ما التالي؟
تأكَّد من تنصيب بايثون على حاسوبك وتشغيل برنامجك الأوَّل.
اختبارات
إليك الاختبار البسيط التالي: حدّد العناصر المختلفة التي درسناها للآن في كود الجافا أدناه:
// a recursive implementation of Factorial
import java.util.Scanner;
class RecursiveFactorial {
 public static void main(String[] args) {
  Scanner input=new Scanner(System.in);
  System.out.print("Find the Factorial of: ");
  int num=input.nextInt();
  System.out.println("Factorial of "+num+" = "+fact(num));
}
 static long fact(int n) {
  if(n<2) return 1;
  return n*fact(n-1);
}
}

تعلمت للآن ماهيَّة الكود المصدري، ودرستَ محتوياته النموذجيَّة. سواءً كان كودك مُصرَّفًا أم مُفسَّرًا، فإنَّه قد يفشَل أثناء تشغيله للعديد من الأسباب. توجد أسباب عادةً مُتعلقة بالأخطاء في كودك المصدري تُعرَف بالعلل. تُدعى عمليّة البحث عن وإزالة العلل بالتنقيح، وهي مهارة عليك قطعًا تعلمها كمبرمج. سنُلقي نظرة على ماهيّة العلل في الجزء القادم من سلسلتنا.
الأجوبة على الاختبارات
حدّد العناصر المختلفة التي درسناها للآن في كود الجافا أدناه:
الكلمات المفتاحيَّة:
import وclass وpublic وstatic وvoid وnew وint وlong وif وreturn.
المُعرِّفات:
java وutil وScanner وRecursiveFactorial وmain وString وargs وinput وSystem وin وout وprint وprintln وnum وnextInt وfact وn.
الحرفيَّات:
الحرفيَّات النصيَّة:":Factorial of" = "Find the Factorial of"
الحرفيَّات العدديّة الصحيحة: 2 و1
العوامل:
عامل الإسناد =
عامل الضم + (لضم سلسلتين نصيتين معًا)
عامل الأصغر من >
عامل الضرب *
عامل الطرح -
علامات الترقيم والرموز:
{ } [] ( ) ; .
التعليقات
//a recursive implementation of Factorial
المصطلحات
المصطلح العربي المصطلح الإنكليزي
كود مصدري Source code
كلمة مفتاحيَّة Keyword
مُعرِّف Identifier
عدّة تطوير برمجيَّات SDK
إطار عمل Framework
كلمة محجوزة Reversed word
مُتغيِّر Variable
سلسلة نصيَّة، سلسلة محارِف String
مصفوفة Array
ثابِت Constant
حرفيَّة Literal
عامِل Operator
جدولة Tab