
صخره نظر به وضعیتی در کد گفته میشود که نظرات آنقدر متراکم و طولانی میشوند که خواندن و درک کد اصلی را دشوار میکنند.
مشکلات صخره نظر:
راهکارهای جلوگیری از صخره نظر:
مثالی از صخره نظر:
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
در مثال بالا، نظرات کوتاه و مختصر هستند و خواندن و درک کد اصلی را آسانتر میکنند.
نکته:
صخره نظر فقط یک مشکل ظاهری نیست، بلکه میتواند بر خوانایی، وضوح و نگهداری کد نیز تأثیر منفی بگذارد.
منابع: