آموزش پایتون

کامنت گذاری در پایتون

نوشتن توضیحات در کدهای پایتون

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

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

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

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

  • کامنت ها می‌توانند برای ارائه توضیحات درباره هر بخش از کدهای پایتون مورد استفاده قرار گیرد.
  • کامنت ها را می توان برای ساده‌تر کردن درک عملکرد هر بخش از کد استفاده کرد.
  • کامنت ها برای بالا بردن میزان خوانایی کدها استفاده می شوند.
  • از کامنت ها می توانید برای جلوگیری از اجرای قسمتی از کد در هنگام آزمایش برنامه استفاده شود.

چگونه در پایتون کامنت بنویسیم؟

کامنت های با یک علامت شارپ  #   شروع می‌شوند، این علامت به مفسر پایتون می فهماند که این قسمت جزو کدهای برنامه نیست و باید آن را نادیده بگیرد.

به مثال زیر توجه کنید:

خروجی این کد به صورت زیر است . در ابتدای خط اول مفسر پایتون به علامت # مواجه می شود و میفهمد که خط اول جزو کدهای برنامه نیست. و آن را نادیده می گیردو بلافاصله به خط بعدی رفته و نتیجه را در خروجی نمایش می دهد.

همچنین می توان کامنت را در انتهای خط قرار داد، در این حالت پایتون کد را اجرا کرده  و بقیه خط را نادیده می‌گیرد:
خروجی این مثال هم مانند مثال قبلی است.

همانطور که در توضیحات بالا اشاره شد از کامنت ها میتوان برای جلوگیری از اجرای کدها هم استفاده کرد . در واقع اگر علامت # قبل از یک کد برنامه ای قرار بگیرد پایتون آن را به عنوان یک کامنت در نظر می گیرد و آن را اجرا نخواهد کرد.

به مثال زیر توجه کنید:

نتیجه اجرای این کد:

کامنت گذاری چند خطی در پایتون

در مثال های بالا یاد گرفتیم که چگونه می توان کامنت های تک خطی را در پایتون نوشت . روش استاندارد پایتون برای کامنت گذاری بصورت تک خطی است. و پایتون قاعده خاصی برای نوشتن کامنت بصورت چند خطی ندارد. ولی در ادامه به طریقه نوشتن کامنت های چند خطی خواهیم پرداخت.

یک روش این است که از علامت # برای چند خط متوالی استفاده شود. اینکار باعث می شود تا هر خط بصورت مجزا به کامنت تبدیل شود. عیب اینکار این است که شاید مجبور شوید تعداد زیادی از خطوط یک قطعه کد را با این روش بصورت کامنت دربیاورید. اینکار علاوه بر اینکه بسیار خسته کننده است وقت زیادی از برنامه نویسی می گیرد. همچنین مغایر با معیارهای کد نویسی سریع که پایتون بر آن پافشاری دارد می باشد.

به مثال زیر توجه کنید:

اما آیا راه بهتری نیست؟ چرا هست . از آنجایی که پایتون رشته ای را که به یک متغیر تخصیص داده نشده را نادیده می گیرد، در نتیجه می توانید کامنت خود را در داخل کوتیشن سه تایی قرار دهید . برای اینکار در ابتدا و انتهای خطوطی که می خواهید به کامنت تبدیل شوند کوتیشن سه تایی قرار دهید.

خروجی مثال بالا:
 

برچسب ها
نمایش بیشتر

نوشته های مشابه

پاسخی بگذارید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *

دوازده + هشت =

این سایت از اکیسمت برای کاهش هرزنامه استفاده می کند. بیاموزید که چگونه اطلاعات دیدگاه های شما پردازش می‌شوند.

دکمه بازگشت به بالا
بستن
بستن