ویرگول
ورودثبت نام
سهراب خان‌بدر | Sohrab Khanbadr
سهراب خان‌بدر | Sohrab Khanbadrچیزی مثبت بگو، و چیز مثبت خواهی دید." — جیم تامپسون من کیستم ؟ من کجا هستم ؟ من چه میخواهم ؟
سهراب خان‌بدر | Sohrab Khanbadr
سهراب خان‌بدر | Sohrab Khanbadr
خواندن ۲ دقیقه·۳ سال پیش

صخره نظر (Comment Cliff) چیست؟


صخره نظر به وضعیتی در کد گفته می‌شود که نظرات آنقدر متراکم و طولانی می‌شوند که خواندن و درک کد اصلی را دشوار می‌کنند.

مشکلات صخره نظر:

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

راهکارهای جلوگیری از صخره نظر:

  • نوشتن نظرات مختصر و مفید: نظرات باید کوتاه، مختصر و تا حد امکان گویا باشند.
  • استفاده از ابزارهای بررسی کد: ابزارهای بررسی کد می‌توانند به شما در شناسایی و حذف نظرات غیرضروری یا تکراری کمک کنند.
  • استفاده از ساختارهای مناسب: استفاده از ساختارهای مناسب کد، مانند توابع و کلاس‌ها، می‌تواند به شما در سازماندهی کدتان و کاهش نیاز به نظرات طولانی کمک کند.

مثالی از صخره نظر:

Python

def my_function(x): """ این تابع یک تابع بسیار پیچیده است که کارهای زیادی انجام می‌دهد. ورودی: x: یک عدد صحیح خروجی: y: یک عدد صحیح """ # مرحله اول: محاسبه a a = x + 1 # مرحله دوم: محاسبه b b = a * 2 # مرحله سوم: محاسبه c c = b / 3 # مرحله چهارم: بازگشت y return c

در مثال بالا، نظرات بسیار طولانی و متراکم هستند و خواندن و درک کد اصلی را دشوار می‌کنند.

راه حل:

Python

def my_function(x): """ این تابع یک تابع ساده است که یک عدد را دو برابر می‌کند. ورودی: x: یک عدد صحیح خروجی: y: دو برابر x """ return x * 2

در مثال بالا، نظرات کوتاه و مختصر هستند و خواندن و درک کد اصلی را آسان‌تر می‌کنند.

نکته:

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

منابع:

  • Wikipedia: Code comment
  • Refactoring Guru: Comment Cliff
۱
۰
سهراب خان‌بدر | Sohrab Khanbadr
سهراب خان‌بدر | Sohrab Khanbadr
چیزی مثبت بگو، و چیز مثبت خواهی دید." — جیم تامپسون من کیستم ؟ من کجا هستم ؟ من چه میخواهم ؟
شاید از این پست‌ها خوشتان بیاید