Konvensi pengkodean dapat menjadi aturan yang didokumentasikan untuk diikuti oleh tim, atau hanya menjadi praktik pengkodean pribadi Anda
Halaman ini menjelaskan konvensi kode JavaScript umum yang digunakan oleh W3Schools
Anda juga harus membaca bab berikutnya "Praktik Terbaik", dan mempelajari cara menghindari kesalahan pengkodean
Nama Variabel
Di W3schools kami menggunakan camelCase untuk nama pengidentifikasi (variabel dan fungsi)
Semua nama dimulai dengan huruf
Di bagian bawah halaman ini, Anda akan menemukan pembahasan yang lebih luas tentang aturan penamaan
nama depan = "John";
lastName = "Doe";
harga = 19. 90;
pajak = 0. 20;
fullHarga = harga + (harga * pajak);
Ruang di Sekitar Operator
Selalu beri spasi di sekitar operator ( = + - * / ), dan setelah koma
Contoh
misalkan x = y + z;
const myArray = ["Volvo", "Saab", "Fiat"];
Indentasi Kode
Selalu gunakan 2 spasi untuk lekukan blok kode
Fungsi
fungsi toCelcius(fahrenheit) {
kembali (5 / 9) * (fahrenheit - 32);
}
Jangan gunakan tab (tabulator) untuk indentasi. Editor yang berbeda menginterpretasikan tab secara berbeda
Aturan Pernyataan
Aturan umum untuk pernyataan sederhana
- Selalu akhiri pernyataan sederhana dengan titik koma
Contoh
const mobil = ["Volvo", "Saab", "Fiat"];
orang konstan = {
nama depan. "Yohanes",
nama keluarga. "Kelinci betina",
usia. 50,
warna mata. "biru"
};
Aturan umum untuk pernyataan kompleks (gabungan).
- Letakkan braket pembuka di akhir baris pertama
- Gunakan satu spasi sebelum braket pembuka
- Letakkan braket penutup pada baris baru, tanpa spasi di depan
- Jangan akhiri pernyataan kompleks dengan titik koma
Fungsi
fungsi toCelcius(fahrenheit) {
kembali (5 / 9) * (fahrenheit - 32);
}
Loop
for (biarkan i = 0; i < 5; i++) {
x += saya;
}
Persyaratan
jika (waktu < 20) {
salam = "Selamat siang";
} kalau tidak {
salam = "Selamat malam";
}
Aturan Objek
Aturan umum untuk definisi objek
- Tempatkan braket pembuka pada baris yang sama dengan nama objek
- Gunakan titik dua ditambah satu spasi di antara setiap properti dan nilainya
- Gunakan tanda kutip di sekitar nilai string, bukan di sekitar nilai numerik
- Jangan tambahkan koma setelah pasangan nilai properti terakhir
- Tempatkan braket penutup pada baris baru, tanpa spasi di depan
- Selalu akhiri definisi objek dengan titik koma
Contoh
orang konstan = {
nama depan. "Yohanes",
nama keluarga. "Kelinci betina",
usia. 50,
warna mata. "biru"
};
Objek pendek dapat ditulis terkompresi, dalam satu baris, menggunakan spasi hanya antar properti, seperti ini
const person = {firstName. "John", nama belakang. "Doe", usia. 50, warna mata. "biru"};
Panjang Garis < 80
Agar mudah dibaca, hindari baris yang lebih panjang dari 80 karakter
Jika pernyataan JavaScript tidak muat dalam satu baris, tempat terbaik untuk menghentikannya adalah setelah operator atau koma
Konvensi Penamaan
Selalu gunakan konvensi penamaan yang sama untuk semua kode Anda. Sebagai contoh
- Nama variabel dan fungsi ditulis sebagai camelCase
- Variabel global ditulis dalam HURUF BESAR (Kami tidak, tetapi cukup umum)
- Konstanta (seperti PI) ditulis dalam UPPERCASE
Haruskah Anda menggunakan hyp-hens, camelCase, atau under_scores dalam nama variabel?
Ini adalah pertanyaan yang sering didiskusikan oleh programmer. Jawabannya tergantung pada siapa Anda bertanya
Tanda hubung dalam HTML dan CSS
Atribut HTML5 dapat dimulai dengan data- (data-quantity, data-price)
CSS menggunakan tanda hubung dalam nama properti (ukuran font)
Tanda hubung dapat disalahartikan sebagai upaya pengurangan. Tanda hubung tidak diperbolehkan dalam nama JavaScript
Garis bawah
Banyak programmer lebih suka menggunakan garis bawah (date_of_birth), terutama di database SQL
Garis bawah sering digunakan dalam dokumentasi PHP
PascalCase
PascalCase sering disukai oleh pemrogram C
camelCase
camelCase digunakan oleh JavaScript itu sendiri, oleh jQuery, dan pustaka JavaScript lainnya
Jangan memulai nama dengan tanda $. Ini akan membuat Anda berkonflik dengan banyak nama perpustakaan JavaScript
Memuat JavaScript dalam HTML
Gunakan sintaksis sederhana untuk memuat skrip eksternal (atribut type tidak diperlukan)
Mengakses Elemen HTML
Konsekuensi dari penggunaan gaya HTML yang "tidak rapi", dapat menyebabkan kesalahan JavaScript
Kedua pernyataan JavaScript ini akan menghasilkan hasil yang berbeda
const obj = getElementById("Demo")
const obj = getElementById("demo")
Jika memungkinkan, gunakan konvensi penamaan yang sama (seperti JavaScript) di HTML
Kunjungi Panduan Gaya HTML
Ekstensi File
File HTML harus memiliki a. ekstensi html (. htm diizinkan)
File CSS harus memiliki a. ekstensi css
File JavaScript harus memiliki a. ekstensi js
Gunakan Nama File Huruf Kecil
Sebagian besar server web (Apache, Unix) peka terhadap nama file
London. jpg tidak dapat diakses sebagai London. jpg
Server web lain (Microsoft, IIS) tidak peka huruf besar-kecil
London. jpg dapat diakses sebagai London. jpg atau london. jpg
Jika Anda menggunakan campuran huruf besar dan kecil, Anda harus sangat konsisten
Jika Anda beralih dari server yang tidak peka huruf besar kecil ke server yang peka huruf besar kecil, bahkan kesalahan kecil pun dapat merusak situs web Anda
Untuk menghindari masalah ini, selalu gunakan nama file dengan huruf kecil (jika memungkinkan)
Pertunjukan
Konvensi pengkodean tidak digunakan oleh komputer. Sebagian besar aturan berdampak kecil pada pelaksanaan program
Lekukan dan spasi ekstra tidak signifikan dalam skrip kecil
Untuk kode dalam pengembangan, keterbacaan harus diutamakan. Skrip produksi yang lebih besar harus diminimalkan