کامنت‌ها در پایتون

زمانی که داریم کد پایتون می‌نویسیم، یکی از مهم‌ترین ابزارها برای سازمان‌دهی و توضیح دادن مستندات کد، استفاده از کامنت‌هاست. کامنت‌ها به ما این امکان را می‌دهند که توضیحاتی درباره عملکرد یا هدف بخشی از کد بنویسیم که فقط برای توسعه‌دهندگان قابل دیدن است و در عملکرد کد تاثیری ندارد.

استفاده صحیح از کامنت‌ها می‌تواند فرآیند نگهداری و تغییر کد را بسیار ساده‌تر کند، چرا که وقتی برنامه‌نویسان دیگر یا حتی خودمان بعد از مدتی به کد نگاه می‌کنیم، می‌توانیم به سرعت بفهمیم که هر بخش از کد چه کاری انجام می‌دهد.

در زبان برنامه‌نویسی پایتون، کامنت‌ها به سادگی و با استفاده از نماد # ایجاد می‌شوند. هر چیزی که بعد از این نماد باشد تا انتهای خط به عنوان کامنت محسوب می‌شود و توسط مفسر پایتون در نظر گرفته نمی‌شود.

همچنین می‌توان از کامنت‌های چند خطی استفاده کرد که در این حالت معمولا از سه علامت نقل قول دوتایی یا تکی استفاده می‌شود (''' ''' یا """ """)، هرچند برای مستند کردن توابع نیز از این قالب استفاده می‌شود که به آن docstring گفته می‌شود.

در کد زیر ما نمونه‌هایی از کامنت‌گذاری در پایتون را بررسی می‌کنیم:

        # این یک کامنت تک‌خطی است
        x = 10  # این خط یک متغیر به نام x ایجاد می‌کند
        
        """
        این یک کامنت چند خطی است
        که می‌توانیم برای توضیحات طولانی‌تر از این حالت استفاده کنیم
        """
        
        def add(a, b):
            """تابعی برای جمع دو عدد"""
            return a + b
    

#: برای ایجاد یک کامنت تک‌خطی استفاده می‌شود. می‌توانیم در هر جایی از کد بنویسیم و هر متنی بعد از آن در نظر گرفته نمی‌شود.
x = 10 # این خط یک متغیر به نام x ایجاد می‌کند: تعریف متغیر x و در همان خط یک توضیح کوتاه درباره عملکرد کد.
""": برای کامنت‌های چند خطی استفاده می‌شود. همچنین به عنوان docstring برای مستند کردن توابع و کلاس‌ها نیز به کار می‌رود.
def add(a, b):: تعریف یک تابع برای جمع دو عدد که در خط بعد با استفاده از docstring توضیح می‌دهیم که این تابع چه کاری انجام می‌دهد.