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

استانداردها و رسوم کدنویسی، گایدلاین ها (راهنما و دستورالعمل) برای زبان های برنامه نویسی هستند که شیوه های خاصی برای کدنویسی را توصیه می کنند. این گایدلاین ها توصیه هایی برای کامنت گذاری، فاصله گذاری، تعریف و نام گذاری متغیرها (variable)، چگونگی فضاهای خالی و … دارند.

بسیار توصیه می شود که برنامه نویسان نرم افزارها حتما از این استانداردها استفاده کنند تا کدهایشان به آسانی توسط سایرین خوانده شود.

برای آشنایی بیشتر با لزوم استفاده از استانداردها می‌توانید به مطلب زیر مراجعه کنید:

معاهده‌های کدنویسی (Coding conventions)

چرا استاندارد نویسی اهمیت دارد؟

گرچه استاندارد نویسی در ابتدا مشکل است و بیهوده به نظر می رسد، اما زمانی که نرم افزارتان بزرگ شود و حجم آن به چند هزار خط در چند صد فایل برسد، فواید آن مشخص می شود. بعضی از این فواید عبارتند از:

  • برنامه نویسان به راحتی می توانند روی کدهایی که توسط دیگران نوشته شده کار کنند. زیرا کدها به روشی نوشته شده اند که هر یک از برنامه نویسان با آن آشنا است.
  • اگر شخص جدیدی وارد تیم پروژه شود، به راحتی می تواند با کدها کار کند (به شرطی که با کدنویسی استاندارد آشنایی داشته باشد.)
  • رعایت استانداردها گاهی از ایجاد اشتباه در کدنویسی نیز جلوگیری می کند.

pep8 - Python style guide checker

PEP 257 docstring style checker

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

Style Guide for Python Code

Google Python Style Guide

Code Style

Code Like a Pythonista: Idiomatic Python

How not to write Python code

Python Idioms and Efficiency

Python Coding Standards

Docstring Conventions