Spesifikasi kod JavaScript
Semua projek JavaScript menggunakan spesifikasi yang sama.
Spesifikasi kod JavaScript
Spesifikasi kod biasanya merangkumi aspek berikut:
-
Peraturan penamaan untuk pembolehubah dan fungsi
Peraturan penggunaan untuk ruang, lekukan dan ulasan.
Spesifikasi lain yang biasa digunakan...
Kod standard lebih mudah dibaca dan diselenggara.
Spesifikasi kod biasanya ditetapkan sebelum pembangunan dan boleh dirundingkan serta ditetapkan dengan ahli pasukan anda.
Nama pembolehubah
Adalah disyorkan untuk menggunakan camelCase untuk nama berubah:
firstName = "John";
lastName = "Doe";
harga = 19.90;
cukai = 0.20;
harga penuh = harga + ( harga * cukai);
Angkasa dan operator
Pengendali biasa ( = + - * / ) Anda perlu menambah ruang sebelum dan selepas:
var x = y + z;
var values = ["Volvo", "Saab", "Fiat"];
Lekukan kod
Biasanya 4 ruang digunakan untuk mengesot blok kod:
Fungsi :
fungsi keCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
Kunci TAB tidak disyorkan untuk inden, kerana editor berbeza mentafsir kunci TAB secara berbeza.
Peraturan Penyata
Peraturan am untuk pernyataan mudah:
Pernyataan biasanya Diakhiri dengan simbol.
var values = ["Volvo", "Saab", "Fiat"];
var person = {
FirstName: "John",
LastName: "Doe",
umur: 50,
eyeColor: "blue"
};
Peraturan am untuk pernyataan kompleks:
Letakkan pendakap kerinting pembukaan di hujung baris pertama.
Tambah ruang sebelum pendakap kerinting kiri.
Letakkan pendakap kerinting penutup pada barisnya sendiri.
Jangan tamatkan pernyataan kompleks dengan koma bertitik.
Fungsi:
berfungsi keCelsius(fahrenheit) {
kembali (5 / 9) * (fahrenheit - 32);
}
Gelung:
untuk (i = 0; i < 5; i++) {
x += i;
}
Keadaan Kenyataan:
jika (masa < 20) {
salam = "Selamat hari";
} lain {
salam = "Selamat petang" ;
}
Peraturan objek
Peraturan untuk definisi objek:
Letakkan pendakap kerinting pembuka pada baris yang sama dengan nama kelas.
Terdapat ruang antara titik bertindih dan nilai atribut.
Gunakan petikan berganda untuk rentetan, tetapi bukan untuk nombor.
Jangan tambahkan koma selepas pasangan atribut-nilai terakhir.
Letakkan pendakap kerinting kanan pada barisnya sendiri dan akhirinya dengan simbol.
var person = {
firstName: "John",
lastName: "Doe",
umur: 50,
eyeColor: "blue"
};
Kod objek pendek boleh ditulis terus dalam satu baris:
var person = { firstName:" John", lastName:"Doe", umur:50, eyeColor:"blue"};
Kurang daripada 80 aksara setiap baris kod
Untuk memudahkan pembacaan, adalah disyorkan untuk mempunyai kurang daripada 80 aksara setiap baris.
Jika pernyataan JavaScript melebihi 80 aksara, adalah disyorkan untuk memutuskan baris selepas operator atau koma.
Instance
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>php中文网(php.cn)</title> </head> <body> <h1>我的 Web 页面</h1> <p> 建议在运算符或者逗号后换行。 </p> <p id="demo"></p> <script> document.getElementById("demo").innerHTML = "Hello php."; </script> </body> </html>
Jalankan program dan mencubanya
Peraturan penamaan
Secara amnya, peraturan penamaan banyak bahasa kod adalah serupa, contohnya:
Pembolehubah dan fungsi ialah camelCase (camelCase)
Pembolehubah global ialah huruf besar (HURUF BESAR)
Pemalar (seperti PI) ialah huruf besar (HURUF BESAR)
Adakah anda menggunakan peraturan ini untuk menamakan pembolehubah? :hyp-hens, camelCase atau under_scores ?
Handbar (-) aksara untuk HTML dan CSS:
Atribut HTML5 boleh menjadi data - (cth: data-kuantiti, data-harga) sebagai awalan.
Penggunaan CSS - untuk menggabungkan nama sifat (saiz fon).
Nota: - biasanya dianggap sebagai penolakan dalam JavaScript, jadi penggunaannya tidak dibenarkan.
Underscore:
Ramai pengaturcara lebih suka menggunakan garis bawah (seperti: date_of_birth), terutamanya dalam pangkalan data SQL.
Bahasa PHP biasanya menggunakan garis bawah.
PascalCase:
PascalCase lebih biasa dalam bahasa C.
Sarung unta:
Sarung unta biasanya disyorkan dalam JavaScript, dan jQuery serta perpustakaan JavaScript lain menggunakan sarung unta.
Nota: Jangan mulakan nama pembolehubah dengan $ kerana ia akan bercanggah dengan banyak perpustakaan JavaScript.
HTML memuatkan fail JavaScript luaran
Memuatkan fail JavaScript menggunakan format ringkas (atribut jenis tidak diperlukan ) :
<script src="myscript.js">
Gunakan JavaScript untuk mengakses elemen HTML
HTML yang tidak diformatkan dengan baik boleh menyebabkan ralat pelaksanaan JavaScript.
Dua pernyataan JavaScript berikut akan mengeluarkan hasil yang berbeza:
<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <title>php中文网(php.cn)</title> </head> <body> <p id="Demo">段落 1。</p> <p id="demo">段落 2。</p> <script> // 只有段落 2 会被替换 document.getElementById("demo").innerHTML = "HELLO."; </script> </body> </html>
Jalankan atur cara dan cuba
Petua: Cuba gunakan peraturan penamaan HTML dan JavaScript yang sama.
Sambungan fail
Akhiran fail HTML boleh menjadi .html (atau r .htm).
Akhiran fail CSS ialah .css.
Akhiran fail JavaScript ialah .js .
Gunakan nama fail huruf kecil
Kebanyakan pelayan web (Apache, Unix) adalah sensitif huruf besar-besaran: london.jpg tidak boleh diakses melalui London.jpg.
Pelayan web lain (Microsoft, IIS) tidak sensitif huruf besar-besaran: london.jpg boleh diakses sebagai London.jpg atau london.jpg.
Anda mesti mengekalkan gaya yang konsisten dan kami mengesyorkan menggunakan nama fail huruf kecil secara konsisten.