الفرق بين المراجعتين لصفحة: «Python/coding-style»
< Python
طلا ملخص تعديل |
ط استبدال النص - 'Python/documentation-strings' ب'Python/documentation_strings' |
||
| (2 مراجعات متوسطة بواسطة نفس المستخدم غير معروضة) | |||
| سطر 6: | سطر 6: | ||
* احرص على أن لا يتجاوز عدد الحروف في السطر الواحد <code>79</code> حرفًا، إذ يسهّل هذا الأمر عرض الشيفرة في الشاشات الصغيرة، ويتيح لأصحاب الشاشات الكبيرة استعراض عدّة ملفات جنبًا إلى جنب. | * احرص على أن لا يتجاوز عدد الحروف في السطر الواحد <code>79</code> حرفًا، إذ يسهّل هذا الأمر عرض الشيفرة في الشاشات الصغيرة، ويتيح لأصحاب الشاشات الكبيرة استعراض عدّة ملفات جنبًا إلى جنب. | ||
* استخدم سطرًا فارغًا لفصل [[Python/ | * استخدم سطرًا فارغًا لفصل [[Python/defining_functions|الدوال]] و<nowiki/>[[Python/class|الأصناف]] عن كتلة الشيفرة الداخلية. | ||
* ضع التعليقات في سطر منفرد إن كان ذلك ممكنًا. | * ضع التعليقات في سطر منفرد إن كان ذلك ممكنًا. | ||
* استخدم [[Python/ | * استخدم [[Python/documentation_strings|سلاسل التوثيق النصية]]. | ||
* استخدم مسافة بيضاء قبل وبعد العامل، ولا تفصل الأقواس عمّا يأتي قبلها أو بعدها، مثلًا: | * استخدم مسافة بيضاء قبل وبعد العامل، ولا تفصل الأقواس عمّا يأتي قبلها أو بعدها، مثلًا: | ||
<syntaxhighlight lang="python3"> | <syntaxhighlight lang="python3"> | ||
a = f(1, 2) + g(3, 4) | a = f(1, 2) + g(3, 4) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* اعتمد طريقة واحدة لتسمية [[Python/class|الأصناف]] و<nowiki/>[[Python/ | * اعتمد طريقة واحدة لتسمية [[Python/class|الأصناف]] و<nowiki/>[[Python/defining_functions|الدوال]]، والمتّفق عليه هو استخدام صيغة <code>CamelCase</code> لتسمية [[Python/class|الأصناف]] وصيغة الحروف الصغيرة مع الشرطات السفلية <code>lower_case_with_underscores</code> لتسمية الدوال والتوابع. استخدم الكلمة المفتاحية <code>self</code> دائمًا كاسم للمعامل الأول في التوابع (راجع [[Python/class|الأصناف]] للمزيد من المعلومات حول الأصناف والتوابع). | ||
* لا تستخدم ترميزات غريبة إن كان شيفرتك ستستخدم في بيئة عالمية، ويفضّل استخدام الترميز الافتراضي في بايثون وهو <code>UTF-8</code> أو الترميز <code>ASCII</code>. كذلك لا تستخدم أحرفًا لا تنتمي إلى الترميز <code>ASCII</code> في المعرّفات في حال وجود احتمال أن يتعامل مع الشيفرة أشخاص يتحدّثون بلغات مختلفة. | * لا تستخدم ترميزات غريبة إن كان شيفرتك ستستخدم في بيئة عالمية، ويفضّل استخدام الترميز الافتراضي في بايثون وهو <code>UTF-8</code> أو الترميز <code>ASCII</code>. كذلك لا تستخدم أحرفًا لا تنتمي إلى الترميز <code>ASCII</code> في المعرّفات في حال وجود احتمال أن يتعامل مع الشيفرة أشخاص يتحدّثون بلغات مختلفة. | ||
== مصادر == | == مصادر == | ||
صفحة [https://docs.python.org/3/tutorial/controlflow.html#intermezzo-coding-style More Control Flow Tools] في توثيق بايثون الرسمي. | * صفحة [https://docs.python.org/3/tutorial/controlflow.html#intermezzo-coding-style More Control Flow Tools] في توثيق بايثون الرسمي. | ||
[[تصنيف:Python]] | [[تصنيف:Python]] | ||
المراجعة الحالية بتاريخ 14:45، 29 مايو 2018
يمكن كتابة (أو بعبارة أدق، تنسيق) معظم اللغات البرمجية بتنسيقات مختلفة، يكون بعضها مقروءًا أكثر من الآخر. وينصح دائمًا بكتابة شيفرات برمجية يمكن للأشخاص الآخرين قراءتها بسهولة، وأفضل طريقة لتحقيق ذلك هي اتباع تنسيق جميل في كتاب الشيفرات البرمجية.
تتّبع معظم المشاريع المكتوبة بلغة بايثون دليل التنسيق PEP 8، والذي يشجّع على اعتماد تنسيق يمتاز بالمقروئية العالية والمظهر الجميل. يجب على كل مطوّر بلغة بايثون أن يطّلع على هذا الدليل، وندرج فيما يلي بعض النقاط المهمّة المستخلصة من هذا الدليل:
- استخدم 4 مسافات بيضاء 4-spaces للإزاحة (indentation) ولا تستخدم علامات الجدولة tabs. المسافات البيضاء الأربعة هي حالة وسطية بين الإزاحة الصغيرة (التي تسمح بالتداخل لمستويات أعمق) والإزاحة الكبيرة (التي تسهّل قراءة الشيفرة). تسبّب علامات الجدولة إرباكًا للقارئ وينصح بعدم استخدامها على الإطلاق.
- احرص على أن لا يتجاوز عدد الحروف في السطر الواحد
79حرفًا، إذ يسهّل هذا الأمر عرض الشيفرة في الشاشات الصغيرة، ويتيح لأصحاب الشاشات الكبيرة استعراض عدّة ملفات جنبًا إلى جنب. - استخدم سطرًا فارغًا لفصل الدوال والأصناف عن كتلة الشيفرة الداخلية.
- ضع التعليقات في سطر منفرد إن كان ذلك ممكنًا.
- استخدم سلاسل التوثيق النصية.
- استخدم مسافة بيضاء قبل وبعد العامل، ولا تفصل الأقواس عمّا يأتي قبلها أو بعدها، مثلًا:
a = f(1, 2) + g(3, 4)
- اعتمد طريقة واحدة لتسمية الأصناف والدوال، والمتّفق عليه هو استخدام صيغة
CamelCaseلتسمية الأصناف وصيغة الحروف الصغيرة مع الشرطات السفليةlower_case_with_underscoresلتسمية الدوال والتوابع. استخدم الكلمة المفتاحيةselfدائمًا كاسم للمعامل الأول في التوابع (راجع الأصناف للمزيد من المعلومات حول الأصناف والتوابع).
- لا تستخدم ترميزات غريبة إن كان شيفرتك ستستخدم في بيئة عالمية، ويفضّل استخدام الترميز الافتراضي في بايثون وهو
UTF-8أو الترميزASCII. كذلك لا تستخدم أحرفًا لا تنتمي إلى الترميزASCIIفي المعرّفات في حال وجود احتمال أن يتعامل مع الشيفرة أشخاص يتحدّثون بلغات مختلفة.
مصادر
- صفحة More Control Flow Tools في توثيق بايثون الرسمي.