انتخاب اسم برای تابع
انتخاب اسمهای خوب برای توابع، بخشی اساسی از نوشتن کد خوب است.
هنگامی که برای تابع خود اسم انتخاب میکنید، توصیههای زیر را در نظر بگیرید.
اسمهای معنادار برای توابع انتخاب کنید
وقتی برای تابع خود اسم انتخاب میکنید، باید روشن باشد که آن تابع چه کاری انجام میدهد.
برای مثال، تابع get(studentId, subject) اسم معناداری ندارد و بنابراین روشن نیست که چه کاری انجام میدهد.
ممکن است نمرهی درس دانشجو را بگیرد یا وضعیت ثبتنام او را.
اسم بهتری مثل getStudentGrade(studentId, subject) مناسبتر است، چون دقیقاً بیان میکند که تابع چه کاری انجام میدهد.
اسم تابع را بیش از حد طولانی نکنید
توجه کنید که اسم تابع را بیش از حد طولانی نکنید.
برای مثال، checkStudentFailOrPassOrMeritOrDistinction(mark) اسم تابعی است که بیدلیل طولانی است.
هر چه اسم طولانیتر باشد، به خاطر سپردنش سختتر میشود و فضای بیشتری روی صفحهی رایانه میگیرد.
اسم تابع را بیش از حد کوتاه نکنید
در مقابل، کوتاه کردن بیش از حد اسم تابع هم میتواند خوانندگان را سردرگم کند.
برای مثال، checkFPMD(mark) اسم تابع بدی است، چون فوراً روشن نیست که «FPMD» به چه معناست.
اسمی را انتخاب کنید که همه آن را میفهمند
اسم تابع شما باید برای هر کسی که کد شما را میخواند قابل فهم باشد.
برای مثال، اسم تابعی مبهم مانند DeathStar() ممکن است برای شما خندهدار باشد، اما هدف آن را بیان نمیکند و میتواند توسعهدهندگان دیگری را که کد شما را میخوانند سردرگم کند.
برای اسمگذاری عملیات، یک قرارداد واحد انتخاب کنید
برای اسمگذاری عملیاتی که کار یکسانی انجام میدهند، به یک قرارداد واحد پایبند باشید.
برای مثال، اگر برای تابعی که اسم دانشجو را میگیرد اسم getStudentName() را انتخاب میکنید، نباید برای گرفتن نمرهی دانشجو از فعل متفاوتی در اسم تابع استفاده کنید (مثلاً retrieveStudentGrade()).
از بهکاربردن یک کلمه برای دو هدف خودداری کنید
برای مثال، اگر قبلاً add را برای جمع دو عدد به کار بردهاید، دیگر از آن برای گذاشتن گروهی از عناصر در یک مجموعه استفاده نکنید.
بهجای آن از insert یا append استفاده کنید.
