روش کدنویسی intermezzo در پایتون

آموزش روش کدنویسی intermezzo در برنامه نویسی پایتون

حال که قرار است بخش های طولانی تر و پیچیده تری از کد پایتون را بنویسید، زمان خوبی است تا درباره روش کدنویسی صحبت کنیم. بیشتر زبان ها را می توان به روش های مختلفی نوشت(یا مختصر کرد). برخی خوانا تر از بقیه هستند. خوانا تر کردن کدتان برای دیگران، همیشه ایده خوبی است، و پذیرش یک روش کدنویسی زیبا کمک بسیار بزرگی است.

. برای پایتون، PEP 8 به عنوان یک راهنمای روش کدنویسی ارائه شد که بیشتر پروژه ها به آن پایبند هستند. PEP 8 یک روش کدنویسی بسیار خوانا و چشم نواز را ترویج می کند. همه توسعه دهندگان پایتون باید زمانی آن را بخوانند. برخی از مهمترین نکات آن برای شما استخراج شده است:

• از 4 فاصله برای فرو رفتگی استفاده کنید، نه tab . 4 فاصله یک سازگاری خوبی بین فرو رفتگی های کوچک و بزرگ ایجاد می کند (ایجاد شبکه تو در توی عمیق تری را امکان پذیر می کند ). Tab ها باعث بروز سردرگمی می شوند و بهتر است از آن استفاده نشود.
• طول خطوط بیشتر از 79 کاراکتر نشود. این امر به کاربران با صفحه نمایش کوچک کمک می کند و علاوه بر آن می توان روی صفحه نمایش بزرگتر چندین فایل کد را در کنار یکدیگر داشت.
• از خطوط خالی برای تفکیک توابع و کلاس ها، و بلاک های بزرگتر کد درون توابع استفاده کنید.
• در صورت امکان، در هر خط توضیحات مربوطه را بنویسید.
• از docstring استفاده کنید.
• در اطراف عملگرها و پس از ویرگول ها از فاصله استفاده کنید، اما نه مستقیما درون ساختار پرانتز : a = f(1, 2) + g(3, 4)
• کلاس ها و توابع را پیوسته و استوار نامگذاری کنید. قرارداد به این صورت است که از حروف بزرگ (UpperCamelCase) برای نامگذاری کلاس ها و از حروف کوچک به همراه خط زیرین (lowercase_with_underscores) برای توابع و متدها استفاده شود. همیشه از self به عنوان نام اولین آرگومان متد استفاده کنید.
• اگر قرار است کد شما در محیط های بین المللی مورد استفاده قرار گیرد، از کدنویسی تجملی بپرهیزید. در هر شرایطی پیش فرض پایتون UTF-8 ، یا حتی ASCII ساده بهترین گزینه است.
• به همین ترتیب، اگر کوچکترین احتمالی وجود دارد که افرادی که به زبان های دیگر صحبت می کنند، کد را بخوانند یا نگه دارند، از کاراکتر های غیر ASCII برای شناسه ها استفاده نکنید.