d6a160445e
* fix: converted single to triple backticks13 * fix: added prefix Co-Authored-By: Tom <20648924+moT01@users.noreply.github.com> * fix: removed language in wrong place Co-Authored-By: Tom <20648924+moT01@users.noreply.github.com> * fix: add language postfix Co-Authored-By: Tom <20648924+moT01@users.noreply.github.com> * fix: removed language in wrong place Co-Authored-By: Tom <20648924+moT01@users.noreply.github.com>
2.1 KiB
title, localeTitle
| title | localeTitle |
|---|---|
| Coding standards | معايير الترميز |
الخطوط العريضة
- لماذا معايير الترميز؟
- مقدمة إلى PEP 8
- الأوامر
لماذا معايير الترميز؟
مجتمع الثعبان العالمي ينمو بسرعة ، ويستخدم كل شخص تقريباً بيثون. هذا هو المكان الذي يمكن فيه قراءة التعليمات البرمجية والمعايير الموحدة. يجب أن يتمكن أي شخص على هذا الكوكب من قراءة الشفرة وفهم ما يفعله. هناك الكثير من الجوانب لفهم رمز الآخرين ، على سبيل المثال التعليقات حول ما تقوم به الوظيفة ، منطقيا تقسيم المهام بين الوحدات والوظائف ، أسماء المتغيرات الجيدة ، إلخ.
مقدمة إلى PEP 8
نحن نحب التمسك بالمعاهدات. لقد توصل مجتمع مستخدمي python إلى مجموعة من المعايير ، والتي يتم اتخاذها الآن على أنها اتفاقية. يتم تشغيل أي رمز مستوى الصناعة التي تكتبها من خلال المدقق PEP 8. ومن ثم ، من الممارسات الجيدة أن تبدأ كتابة التوثيق لصفوفك ووظائفك ، وأن تقوم بتسمية المتغيرات في حالة الأحرف السفلية باستخدام الشُرَط السفلية المربعة. قد يكون من المفيد إلقاء نظرة على هذه المعايير قبل بدء الترميز.
الأوامر
إليك كيفية التحقق مما إذا كان رمز python الخاص بك يتوافق مع المعايير.
:~$ pip install pep8
:~$ pep8 --first myCode.py
سيعطي هذا كل تلك الخطوط التي تنتهك المعايير ، إلى جانب وصف قصير للإصلاحات.