Google'da kod yozish standartlari
Google'da kod yozish uchun belgilab qo'yilgan standartlar bor:
● "Class/function/variable"larni qanday nomlash
● "Package" strukturasi qanday bo'lishi kerakligi
● Kommentlarni qanday yozish va hokazolar uchun ma'lum qoidalar va tavsiyalar mavjud.
Bunday standartlar nega kerak?
Har bir dasturchining o'z kod yozish uslubi bo'ladi. Bir necha o'ng minglab dasturchilari bor kompaniyada hamma o'z xohlaganicha kod yozishi keyinchalik kodlarning tushunarsiz yoki murakkab bo'lishiga olib kelishi mumkin. Masalan, kimdir o'zgaruvchilarning nomini faqat qisqartirilgan so'zlar bilan (m, src) yozishni ma'qul ko'radi. Boshqa dasturchi bo'lsa, uzunroq (userList, dataSource) nomlarni ishlatadi. Agar shu 2 ta odam bitta faylga o'zi bilganicha kod yozsa, uni o'qiydigan uchinchi odamga kodni tushunish qiyin bo'ladi. Shunga o'xshagan sabablar tufayli Google'da standartlar belgilab qo'yilgan. Ularni "style guide" (uslubiy qo'llanma) deb ataladi.
Har bir dasturlash tili uchun alohida qo'llanmalar bor. Ularni asosan 3 ta turga ajratsa bo'ladi:
1. Xatoliklar va murakkabliklarni oldini olish uchun belgilangan qoidalar. Masalan, "static variable" lardan foydalanish uchun ruxsat berilgan holatlar bor. Qolgan hollarda ulardan foydalanmaslik kerak.
2. Yaxshi usulda kod yozish ("best practices") ni targ'ib qiladigan qoidalar. Masalan, Java'da argumentlarning nomlarini kommentda yozib ketish yaxshi amaliyot hisoblanadi.
Ushbu kod
getUserSettings(/* userId= */ 232454, /* extended= */ false)
quyidagi koddan yaxshiroq:
getUserSettings(232454, false)
3. Kodlar bir xilda bo'lishini ta'minlaydigan qoidalar. Masalan, Google'da "indentation" uchun 2 ta "space" ishlatish kerak.
Bunday standartlarning ba'zilari majburiy, ba'zilari ixtiyoriy (lekin qat'iy tavsiya qilinishi mumkin) bo'ladi.
Qoidalarni hammasini eslab qolish qiyin-ku?!
Avvalo, biror tilda birinchi marta kod yozishdan oldin, o'sha til uchun "style guide"ni o'qib chiqish kerak. To'g'ri, yuzlab qoidalarni eslab qolish qiyin. Shu sababli ba'zi bir yordamlar bor:
● Agar esingizdan chiqib, kodning biror joyida standartga amal qilmagan bo'lsangiz, kodni tekshiruvchilar sizga buni eslatib qo'yishlari mumkin.
● Kodni topshirishdan oldin avtomatlashtirilgan tizimlar ("Error checkers") koddagi ko'p kamchiliklarni aniqlab bera oladi.
● IDE larda odatda kodni format qilib beradigan Google'ning plagini ("Code formatter") o'rnatilgan bo'ladi. U kodni to'g'ri formatga keltirib beradi.
Bir qarashda, bunday standartlar va qoidalar kod yozish jarayonini qiyinlashtiradigandek tuyuladi. Aslida unday emas. Boshida 1-2 hafta qiyinroq bo'lishi mumkin xolos. Lekin kelajakda bundan barchaga keladigan foyda – juda katta.
@muhammadjohns
Google'da kod yozish uchun belgilab qo'yilgan standartlar bor:
● "Class/function/variable"larni qanday nomlash
● "Package" strukturasi qanday bo'lishi kerakligi
● Kommentlarni qanday yozish va hokazolar uchun ma'lum qoidalar va tavsiyalar mavjud.
Bunday standartlar nega kerak?
Har bir dasturchining o'z kod yozish uslubi bo'ladi. Bir necha o'ng minglab dasturchilari bor kompaniyada hamma o'z xohlaganicha kod yozishi keyinchalik kodlarning tushunarsiz yoki murakkab bo'lishiga olib kelishi mumkin. Masalan, kimdir o'zgaruvchilarning nomini faqat qisqartirilgan so'zlar bilan (m, src) yozishni ma'qul ko'radi. Boshqa dasturchi bo'lsa, uzunroq (userList, dataSource) nomlarni ishlatadi. Agar shu 2 ta odam bitta faylga o'zi bilganicha kod yozsa, uni o'qiydigan uchinchi odamga kodni tushunish qiyin bo'ladi. Shunga o'xshagan sabablar tufayli Google'da standartlar belgilab qo'yilgan. Ularni "style guide" (uslubiy qo'llanma) deb ataladi.
Har bir dasturlash tili uchun alohida qo'llanmalar bor. Ularni asosan 3 ta turga ajratsa bo'ladi:
1. Xatoliklar va murakkabliklarni oldini olish uchun belgilangan qoidalar. Masalan, "static variable" lardan foydalanish uchun ruxsat berilgan holatlar bor. Qolgan hollarda ulardan foydalanmaslik kerak.
2. Yaxshi usulda kod yozish ("best practices") ni targ'ib qiladigan qoidalar. Masalan, Java'da argumentlarning nomlarini kommentda yozib ketish yaxshi amaliyot hisoblanadi.
Ushbu kod
getUserSettings(/* userId= */ 232454, /* extended= */ false)
quyidagi koddan yaxshiroq:
getUserSettings(232454, false)
3. Kodlar bir xilda bo'lishini ta'minlaydigan qoidalar. Masalan, Google'da "indentation" uchun 2 ta "space" ishlatish kerak.
Bunday standartlarning ba'zilari majburiy, ba'zilari ixtiyoriy (lekin qat'iy tavsiya qilinishi mumkin) bo'ladi.
Qoidalarni hammasini eslab qolish qiyin-ku?!
Avvalo, biror tilda birinchi marta kod yozishdan oldin, o'sha til uchun "style guide"ni o'qib chiqish kerak. To'g'ri, yuzlab qoidalarni eslab qolish qiyin. Shu sababli ba'zi bir yordamlar bor:
● Agar esingizdan chiqib, kodning biror joyida standartga amal qilmagan bo'lsangiz, kodni tekshiruvchilar sizga buni eslatib qo'yishlari mumkin.
● Kodni topshirishdan oldin avtomatlashtirilgan tizimlar ("Error checkers") koddagi ko'p kamchiliklarni aniqlab bera oladi.
● IDE larda odatda kodni format qilib beradigan Google'ning plagini ("Code formatter") o'rnatilgan bo'ladi. U kodni to'g'ri formatga keltirib beradi.
Bir qarashda, bunday standartlar va qoidalar kod yozish jarayonini qiyinlashtiradigandek tuyuladi. Aslida unday emas. Boshida 1-2 hafta qiyinroq bo'lishi mumkin xolos. Lekin kelajakda bundan barchaga keladigan foyda – juda katta.
@muhammadjohns