التعليقات Swift

في هذا المقال، ستعرف عن تعليقات Swift، لماذا وكيف تستخدمها.

تعليقات هي تفسيرات أو تعليقات يمكن للبرمجية قراءتها في رمز المصدر. يتم تجاهلها عند تجميع الكود.

تعليقات لجعل من يقرأ الكود يفهم نوايا البرنامج وفوائده. يمكن أن تكون مفيدة جدًا عند العمل في فريق، حيث يمكن توضيح أهداف الكود للمطورين الآخرين، أو عند العمل بمفرد، حيث يمكن أن تكون تذكيرًا لنفسك.

تعليقات Swift وأنواعها

يوجد في Swift نوعان من التعليقات:

1. تعليقات سطر

في Swift، أي سطر يبدأ ببصمة الشيفرة // يعتبر تعليقًا سطرًا، وكل سطر يبدأ ببصمة الشيفرة // سيُغض الطرف عنه من قبل المُعالج.

يمكنك العثور على مثال بسيط في أعلى playground:

//: مسرح - اسم: مكان يمكن أن يلعب فيه الناس

تبدأ ببصمة الشيفرة //، وتقدم تفسيرًا مفيدًا للملف، مثل: "مسرح - اسم: مكان يمكن أن يلعب فيه الناس".

مثال 1: تعليقات سطر

//برنامج مثال
//يخزن 3.14 في المتغير pi
let pi = 3.14159　
print(pi)

المثال أعلاه يحتوي على تعليقات متعددة الأسطر:

//برنامج مثال
//يخزن 3.14 في المتغير pi

2. تعليقات متعددة الأسطر

إذا كان تعليقك يحتوي على أسطر متعددة، يمكنك تضمينه بين /*...*/.

تبدأ التعليقات المتعددة الأسطر ببصمة الشيفرة، ثم تبدأ بزخرفة (*)، وتنتهي بزخرفة (*). يغض مُعالج Swift الطرف عن جميع المحتويات بين /* و */.

/* هذا هو تعليق متعدد الأسطر.
أضف *، ثم / لإنهاء التعليق المتعدد الأسطر بعد كتابة تعليق متعدد الأسطر
*/

مثال 2: تعليقات متعددة الأسطر

/* قيمة pi المُقاسنة قد لا تكون دقيقة.
لذلك، يمكنك استخدام أنواع البيانات المدمجة حساب القيم الدقيقة
*/
let pi = Double.pi
print(pi)

المثال أعلاه يحتوي على تعليقات متعددة الأسطر.

/* قيمة pi المُقاسنة قد لا تكون دقيقة.
لذلك، يمكنك استخدام أنواع البيانات المدمجة حساب القيم الدقيقة
*/

الأمور التي يجب تذكرها

على الرغم من أن التعليقات مهمة جدًا لفهم نوايا الكود المكتوب. ولكن يجب الانتباه إلى:

1. لا تدخل التعليقات في الأسطر المتعددة بين //، على الرغم من أن ذلك صحيح، وأن المُعالج يغض الطرف عن هذه الأسطر. على العكس من ذلك، يجب وضعها في التعليقات المتعددة الأسطر /* ... */
   مثال:

   //هذا تعليق
   //استخدمها عند الحاجة وبالضبط

   طريقة كتابة التعليقات الصحيحة، ولكن لا ينصح بها، لأنه إذا كان التعليق أكبر من سطر واحد،则需要 كتابة تعليقات متعددة الأسطر. أفضل طريقة للكتابة هي استخدام التعليقات المتعددة الأسطر كـ:

   /*هذا هو تعليق.
   استخدمها عند الحاجة بشكل دقيق
   */

2. يمكن كتابة التعليقات في سطر منفرد، أو مع الكود في نفس السطر. ولكن يُنصح بكتابة التعليقات في سطر منفرد.
   مثال:

   let pi = 3.14159 //يخزن 3.14 في المتغير pi

   طريقة كتابة التعليقات هذه فعالة. ولكن من الأفضل كتابة التعليقات في سطر منفرد:
   

   //يخزن 3.14 في المتغير pi
   let pi = 3.14159

3. حتى لو كنت مبرمجًا واحدًا في فريق، فإنه من الصعب العثور على استخدام الكود بدون تعليقات. لذا استخدمها بشكل دقيق وتقدم وصفًا معنيًا.

4. اجعل التعليقات بسيطة ومفيدة.

5. لا تكتب تعليقات غير ضرورية على الكود.

6. في معظم الحالات، استخدم التعليقات لشرح 'لماذا' وليس 'كيف'.