راهنمای نگارش (Style Guide)
این راهنمای نگارش جاوااسکریپت یعنی قوانین ساده خوش نویسی کد. با این قوانین، کدت خواناتر می شود و تیم راحت تر کار می کند.
نام گذاری متغیرها و توابع (camelCase)
نام ها با حرف شروع شوند. بهتر است camelCase بنویسی.
let firstName = "John";
let lastName = "Doe";
let price = 19.90;
let tax = 0.20;
let fullPrice = price + (price * tax);
فاصله ها دور عملگرها
دور =، +، -، *، / فاصله بگذار. بعد از ویرگول هم فاصله بگذار.
let x = y + z;
const myArray = ["Volvo", "Saab", "Fiat"];
تورفتگی کد (Indentation)
برای هر بلوک، دو فاصله بزن. از تب استفاده نکن.
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
قوانین دستورهای ساده و ترکیبی
ساده ها را با سمی کالن تمام کن. آکلاد باز در همان خط می آید.
const person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor: "blue"
};
for (let i = 0; i < 5; i++) {
x += i;
}
if (time < 20) {
greeting = "Good day";
} else {
greeting = "Good evening";
}
طول خط کمتر از 80 کاراکتر
اگر خط طولانی شد، بعد از عملگر یا ویرگول بشکن.
document.getElementById("demo").innerHTML =
"Hello Dolly.";
قراردادهای نام گذاری
برای همه جا یک سبک ثابت انتخاب کن: camelCase، UPPERCASE برای ثابت ها.
هشدار: خط تیره در جاوااسکریپت مجاز نیست و اشتباه می شود.
بارگذاری اسکریپت در HTML
ساده بنویس. type لازم نیست.
<script src="myscript.js"></script>
دسترسی به عناصر HTML
حروف کوچک و بزرگ در id فرق دارند. نام ها را یکدست بنویس.
const obj1 = getElementById("Demo");
const obj2 = getElementById("demo");
پسوند و حروف نام فایل ها
HTML با .html، سی اس اس با .css، جاوااسکریپت با .js باشد.
نام فایل ها را حتماً حروف کوچک بگذار تا سرورها گیج نشوند.
کارایی
قوانین نگارشی برای خوانایی هستند. در تولید نهایی می توان کمینه کرد.
گام های عملی
- یک فایل .js بساز و یک تابع بنویس.
- نام گذاری camelCase را همه جا رعایت کن.
- خط های بلند را در نقطه ی مناسب بشکن.
جمع بندی سریع
- camelCase برای نام ها بهتر است.
- دور عملگرها فاصله بگذار.
- تورفتگی دو فاصله باشد.
- خط ها کوتاه و تمیز بمانند.
- type در اسکریپت لازم نیست.
برای ادامه، بلوک های کد و حالت سخت گیرانه را بخوان. همچنین راهنمای نگارش جاوااسکریپت را به عنوان مرجع تیم نگه دار.