جدول المحتويات
4.8. فاصل: أسلوب الترميز #
الآن وقد أوشكتَ على كتابة أجزاء أطول وأكثر تعقيدًا من بايثون، فقد حان الوقت للحديث عن أسلوب الترميز. يمكن كتابة معظم اللغات (أو تنسيقها بشكل أكثر إيجازًا) بأساليب مختلفة؛ بعضها أسهل قراءة من غيره. تسهيل قراءة شيفرتك للآخرين فكرة جيدة دائمًا، واعتماد أسلوب ترميز جيد يُساعد بشكل كبير في ذلك.
بالنسبة لبايثون، برز PEP 8 كدليل أسلوب تلتزم به معظم المشاريع؛ فهو يُعزز أسلوب ترميز سهل القراءة ومريح للعين. ينبغي على كل مطور بايثون قراءته في مرحلة ما؛ إليك أهم النقاط المُستخلصة:
- استخدم مسافة بادئة من 4 مسافات، ولا تستخدم علامات التبويب.
- تُمثل المسافات الأربع حلاً وسطًا جيدًا بين المسافة البادئة الصغيرة (التي تسمح بعمق تداخل أكبر) والمسافة البادئة الكبيرة (التي تُسهل القراءة). تُسبب علامات التبويب لبسًا، ومن الأفضل تركها.
- احرص على لف الأسطر بحيث لا تتجاوز 79 حرفًا.
- يُساعد هذا المستخدمين الذين لديهم شاشات صغيرة، ويُتيح إمكانية عرض عدة ملفات برمجية جنبًا إلى جنب على الشاشات الأكبر.
- استخدم أسطرًا فارغة لفصل الدوال والفئات، وكتلًا برمجية أكبر داخل الدوال.
- إن أمكن، ضع التعليقات في سطر منفصل.
- استخدم سلاسل التوثيق.
- استخدم المسافات حول العوامل وبعد الفواصل، ولكن ليس مباشرةً داخل الأقواس: a = f(1, 2) + g(3, 4).
- سمِّ فئاتك ووظائفك بشكل متسق؛ فالمعتاد هو استخدام UpperCamelCase للفئات وlowercase_with_underscores للدوال والطرق. استخدم دائمًا self كاسم لمتغير الطريقة الأول (انظر “نظرة أولى على الفئات” لمزيد من المعلومات حول الفئات والطرق).
- لا تستخدم ترميزات معقدة إذا كان الكود مُصممًا للاستخدام في بيئات دولية. يعمل ترميز بايثون الافتراضي، UTF-8، أو حتى ASCII البسيط بشكل أفضل في جميع الأحوال.
- وبالمثل، لا تستخدم أحرفًا غير ASCII في المعرفات إذا كان هناك احتمال ضئيل جدًا أن يقرأ الأشخاص الذين يتحدثون لغة أخرى الكود أو يحفظونه.
