یکی از مهمترین جنبههای نوشتن کد قابل نگهداری، نامهاییست که برای اجزای کد استفاده میکنیم. هنر نامگذاری در برنامه نویسی جنبه مهمی از نوشتن کدهای تمیز، قابل نگهداری و قابل فهمه. در اینجا چند نکته که هنگام نامگذاری باید در نظر گرفته شن رو بررسی میکنیم:
واضح و توصیفی بودن: نام هایی رو انتخاب کنین که به طور دقیق و واضح هدف متغیر، تابع، کلاس یا سایر عناصر رو توصیف کنن. از نامهای مبهم یا بیش از حد عمومی که ممکنه منجر به سردرگمی شن دوری کنین.
تداوم داشتن: قوانین نامگذاریتون رو در سراسر کد حفظ کنین. از الگوهای نامگذاری مشابه برای عناصر مرتبط برای ایجاد حس انسجام و بهبود خوانایی استفاده کنین.
نامگذاری به صورت Intention-Revealing: از نامهایی استفاده کنین که قصد یا رفتار کد رو آشکار میکنن. باید از استفاده نامهای مبهم یا گمراهکننده که درک کد رو سخت میکنن، دوری کرد.
نامگذاری مختصر: در حالی که وضوح مهمه، سعی کنین نام رو مختصر نگه دارین و از پرحرفی های غیر ضروری خودداری کنین. نام های طولانی و پیچیده می تونن خوندن و درک کد رو سخت کنن.
نامگذاری مختصر: در حالی که وضوح مهمه، سعی کنین نام رو مختصر نگه دارین و از پرحرفی های غیر ضروری خودداری کنین. نام های طولانی و پیچیده می تونن خوندن و درک کد رو سخت کنن.
از کلمات اختصاری دوری کنین: اگه استفاده از اختصارات توی پروژهتون پذیرفته شدهست، شاید اشکال نداشته باشه که اینطور نام گذاری داشته باشین ولی به صورت کلی استفاده از اختصارات یا کلمات اختصاری بیش از حد، ممکنه خوانندگان رو سردرگم کنه. اسامی صریح و معنی دار رو به اختصارات پیچیده ترجیح بدین.
استفاده از CamelCase یا snake_case: یک سبک نامگذاری ثابت، CamelCase (با حروف بزرگ برای هر کلمه شروع میشود) یا snake_case (استفاده از _ برای جدا کردن کلمات) انتخاب کنین و بهش پایبند باشین.
پرسیدن نظر دیگران: وقتی در مورد نامی شک دارین، از همکاراتون بازخورد بگیرین. این کار به روشن شدن ابهامات کمک میکنه.
اجتناب از نامگذاری بیش از حد: از استفاده مجدد از یک نام برای اهداف متعدد در یک زمینه خودداری کنین. هر نام باید در محدوده مشخص، معنای روشن و متمایز داشته باشه.