nodejs

نوشتن کد تمیز یکی از تمارینی هست که شما رو به یک توسعه دهنده حرفه ای تبدیل کنه ، هیچ چیزی مانع این نیست که شما رو بهترین کنه

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

در قدم اول باید متوجه معنای Clean code بشیم ، اینکه چیه و به چه معناست ، Clean code یا کد تمیز به این معناست که شخص شما کدی بنویسه که پس از مدتی خودتان متوجه معنای آن بشین ، همچنین کدی که بقیه همکارانتون یا کد نویس دیگر بتونه اون کد رو به راحتی بخونه و براش قابل درک باشه ، پس به چندین راه حل میپردازیم تا کد شما رو خوانا تر بکنه :

1. گذاشتن اسم های معنا دار برای متغیرهاتون

هیچ گاه برای گذاشتن اسم متغیر از کلمات بی معنی استفاده نکنید یا از تک حرف مثل a و b و ... استفاده نکنید ، چون خودتون پس از مدتی اگه به کدتون نگاه بندازین دچار سر درگمی میشین و دنبال این هستین که این متغیر قراره چه کاری برای من انجام بده.

2. گذاشتن اسامی انگلیسی برای متغیر ها و تابع ها

در حد امکان سعی کنید از اسم با کلمه انگلیسی استفاده کنید ، که اگر روزی قصد همکاری با افراد خارج از کشور رو داشتین و خواستین نمونه کار ارائه بدین دچار دردسر نشین ، همونطور که میبینیم توسعه دهنده هایی زیادی در سرتاسر دنیا هستن و کدهاشون رو با هم در سایت هایی چون github و gitlab به اشتراک میزارن ، پس بهتره که از اسامی انگلیسی استفاده کنید.

3. اسامی که انتخاب میکنید نه زیاد کوتاه باشد نه زیاد بلند

همیشه و همیشه سعی کنید که اسامی انتخاب کنید که معنای کاملی داشته باشند و معنا رو به صورت ناقص بیان نکرده باشه تا قابل درک باشه و حد الامکان کوتاه و با معنا باشد.

// DON'T
let d
let elapsed
const ages = arr.map((i) => i.age)

// DO
let daysSinceModification
const agesOfUsers = users.map((user) => user.age)

4. از نام گذاری Camel case برای متغیر ها و تابع ها استفاده کنید

برای نام گذاری متغیر ها و تابع ها بهتر است به سبک نام گذاری Camel case استفاده کنید ، به مثال های زیر توجه کنید :

// DO
let daysSinceModification
const agesOfUsers

function doSomeWork(){
// Do some work
}

5. از نوشتن کلمات اضافی برای نام گذاری متغیر ها پرهیز کنید

کلمات اضافه به نام متغیر ها اضافه نکنید ، چرا که گذاشتن کلمات اضافی باعث کم حوصلگی در خواندن آن میشود ، برای مثال از نام گذاری به صورت Hungarian notation برای نام گذاری متغیر ها پرهیز کنید

// DON'T
let nameString
let theUsers

// DO
let name
let users

این قسمت از نوشتن Clean code به پایان رسید ، امیدوارم که مورد رضایت شما دوستان بوده باشه