มักจะใช้การประชุมการเข้ารหัสเดียวกันสำหรับโครงการ JavaScript ของคุณทั้งหมด
JavaScript ประชุม Coding
การประชุมการเข้ารหัสเป็นแนวทางรูปแบบการเขียนโปรแกรม พวกเขามักจะครอบคลุมถึง:
- การตั้งชื่อและการประกาศกฎระเบียบสำหรับตัวแปรและฟังก์ชั่น
- กฎระเบียบสำหรับการใช้งานของพื้นที่สีขาวเยื้องและการแสดงความคิดเห็น
- การเขียนโปรแกรมการปฏิบัติและหลักการ
การเข้ารหัสการประชุมที่มีคุณภาพที่เชื่อถือได้
- ช่วยเพิ่มความสามารถในการอ่านรหัส
- ทำให้การบำรุงรักษารหัสได้ง่ายขึ้น
การประชุมการเข้ารหัสสามารถเอกสารกฎสำหรับทีมที่จะปฏิบัติตามหรือเพียงแค่เป็นทางปฏิบัติการเข้ารหัสส่วนบุคคลของคุณ
หน้านี้อธิบายถึงการประชุมทั่วไปโค้ด JavaScript ใช้โดย w3ii
นอกจากนี้คุณยังควรอ่านบทต่อไป "Best Practices" และเรียนรู้วิธีการหลีกเลี่ยงข้อผิดพลาดการเข้ารหัส
ชื่อตัวแปร
ที่เราใช้ w3ii CamelCase สำหรับชื่อตัวบ่งชี้ (ตัวแปรและฟังก์ชั่น)
ชื่อทั้งหมดเริ่มต้นด้วยตัวอักษร
ที่ด้านล่างของหน้านี้คุณจะได้พบกับการสนทนาในวงกว้างเกี่ยวกับกฎการตั้งชื่อ
firstName = "John";
lastName = "Doe";
price = 19.90;
tax = 0.20;
fullPrice = price + (price * tax);ช่องว่างผู้ประกอบการ
มักจะใส่ช่องว่างรอบ ๆ ผู้ประกอบการ ( = + - * / ) และหลังจากเครื่องหมายจุลภาค:
ตัวอย่าง:
var x = y + z;
var values = ["Volvo", "Saab",
"Fiat"];รหัสเยื้อง
มักจะใช้ 4 ช่องว่างสำหรับการเยื้องของบล็อกรหัส:
ฟังก์ชั่น:
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
ไม่ได้ใช้แท็บ (tabulators) สำหรับการเยื้อง บรรณาธิการที่แตกต่างกันตีความแท็บที่แตกต่างกัน
กฎระเบียบคำสั่ง
กฎทั่วไปสำหรับงบง่าย:
- มักจะจบคำง่ายๆด้วยเครื่องหมายอัฒภาค
ตัวอย่าง:
var values = ["Volvo", "Saab",
"Fiat"];
var person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor:
"blue"
};กฎทั่วไปสำหรับการที่ซับซ้อน (สารประกอบ) งบ:
- ใส่วงเล็บเปิดในตอนท้ายของบรรทัดแรก
- ใช้ช่องว่างก่อนวงเล็บเปิด
- ใส่วงเล็บปิดในบรรทัดใหม่โดยไม่เว้นวรรคชั้นนำ
- ไม่สิ้นสุดคำสั่งที่ซับซ้อนด้วยเครื่องหมายอัฒภาค
ฟังก์ชั่น:
function toCelsius(fahrenheit) {
return (5 / 9) * (fahrenheit - 32);
}
loops:
for (i = 0; i < 5; i++) {
x += i;
}เงื่อนไข:
if (time < 20) {
greeting = "Good day";
} else {
greeting = "Good evening";
}กฎวัตถุ
กฎทั่วไปสำหรับคำจำกัดความวัตถุ:
- วางวงเล็บเปิดในบรรทัดเดียวกับชื่อวัตถุ
- ใช้ลำไส้ใหญ่บวกพื้นที่ระหว่างแต่ละคุณสมบัติและความคุ้มค่า
- ใช้คำพูดรอบค่าสตริงค่าเป็นตัวเลขไม่ได้รอบ
- ไม่ต้องเพิ่มจุลภาคหลังจากที่ผ่านมาคู่ของคุณสมบัติที่มีมูลค่า
- วางวงเล็บปิดในบรรทัดใหม่โดยไม่เว้นวรรคชั้นนำ
- มักจะจบความหมายวัตถุด้วยเครื่องหมายอัฒภาค
ตัวอย่าง
var person = {
firstName: "John",
lastName: "Doe",
age: 50,
eyeColor:
"blue"
};วัตถุสั้นสามารถเขียนได้บีบอัดในหนึ่งบรรทัดโดยใช้ช่องว่างระหว่างคุณสมบัติเช่นนี้
var person = {firstName:"John", lastName:"Doe", age:50, eyeColor:"blue"};ความยาวบรรทัด <80
สำหรับการอ่าน, หลีกเลี่ยงเส้นนานกว่า 80 ตัวอักษร
หากคำสั่ง JavaScript ไม่พอดีในหนึ่งบรรทัด, สถานที่ที่ดีที่สุดที่จะทำลายมันคือหลังจากที่ผู้ประกอบการหรือเครื่องหมายจุลภาค
การตั้งชื่อ
มักจะใช้แผนการตั้งชื่อเหมือนกันสำหรับทุกรหัสของคุณ ตัวอย่างเช่น:
- ตัวแปรและฟังก์ชั่นชื่อเขียนเป็น CamelCase
- ตัวแปรทั่วโลกเขียนตัวพิมพ์ใหญ่ (เราไม่ แต่มันก็เป็นเรื่องธรรมดามาก)
- ค่าคงที่ (เช่น PI) เขียนตัวพิมพ์ใหญ่
คุณควรใช้ HYP-ไก่ CamelCase หรือ under_scores ในชื่อตัวแปร?
นี่คือคำถามที่โปรแกรมเมอร์มักจะหารือเกี่ยวกับ คำตอบขึ้นอยู่กับคนที่คุณถาม:
ยัติภังค์ใน HTML และ CSS:
HTML5 แอตทริบิวต์สามารถเริ่มต้นด้วย DATA- (ข้อมูลปริมาณข้อมูลราคา)
CSS ใช้ยัติภังค์ในชื่อคุณสมบัติ (font-size)
ยัติภังค์สามารถเข้าใจผิดว่าเป็นความพยายามในการลบ ยัติภังค์ไม่ได้รับอนุญาตในชื่อของ JavaScript
ตอกย้ำ:
โปรแกรมเมอร์หลายคนชอบที่จะใช้ขีดล่าง (date_of_birth) โดยเฉพาะอย่างยิ่งในฐานข้อมูล SQL
ขีดมักจะใช้ในเอกสาร PHP
PascalCase:
PascalCase มักจะเป็นที่ต้องการโดยโปรแกรมเมอร์ C
CamelCase:
CamelCase จะถูกใช้โดย JavaScript เองโดย jQuery และห้องสมุด JavaScript อื่น ๆ
ไม่ได้เริ่มต้นชื่อด้วยเครื่องหมาย $ มันจะทำให้คุณอยู่ในความขัดแย้งกับหลายชื่อห้องสมุด JavaScript
โหลด JavaScript ใน HTML
ใช้ไวยากรณ์ที่เรียบง่ายสำหรับการโหลดสคริปต์ภายนอก (ประเภทแอตทริบิวต์ที่ไม่จำเป็น):
<script src="myscript.js">
การเข้าถึงองค์ประกอบ HTML
เป็นผลมาจากการใช้ "รก" รูปแบบ HTML ที่อาจจะเกิดข้อผิดพลาด JavaScript
ทั้งสองงบ JavaScript จะให้ผลลัพธ์ที่แตกต่างกัน:
var obj =
getElementById("Demo")
var obj = getElementById("demo")
ถ้าเป็นไปได้ใช้แผนการตั้งชื่อเดียวกัน (ตามจาวาสคริปต์) ในรูปแบบ HTML
นามสกุลไฟล์
ไฟล์ HTML ควรมีนามสกุล .html (ไม่ .htm)
ไฟล์ CSS ควรมีนามสกุล .css
ไฟล์ JavaScript ควรมีนามสกุล .js
ใช้กรณีที่ต่ำกว่ารายชื่อไฟล์
ส่วนใหญ่เว็บเซิร์ฟเวอร์ (Apache, Unix) เป็นกรณีที่สำคัญเกี่ยวกับชื่อไฟล์:
london.jpg ไม่สามารถเข้าถึงได้เป็น London.jpg
เว็บเซิร์ฟเวอร์อื่น ๆ (ไมโครซอฟท์ IIS) จะไม่ได้เป็นกรณีที่สำคัญ:
london.jpg สามารถเข้าถึงได้เป็น London.jpg หรือ london.jpg
ถ้าคุณใช้การผสมผสานของบนและล่างกรณีที่คุณจะต้องมีความสอดคล้องกันมาก
หากคุณย้ายจากกรณีตายไปยังเซิร์ฟเวอร์ที่มีความสำคัญกรณีแม้ข้อผิดพลาดเล็ก ๆ สามารถทำลายเว็บไซต์ของคุณ
เพื่อหลีกเลี่ยงปัญหาเหล่านี้มักจะใช้ชื่อไฟล์กรณีที่ต่ำกว่า (ถ้าเป็นไปได้)
ประสิทธิภาพ
การประชุมการเข้ารหัสไม่ได้ใช้คอมพิวเตอร์ กฎส่วนใหญ่จะมีผลกระทบต่อการดำเนินการของโปรแกรม
เยื้องและพื้นที่พิเศษไม่ได้อย่างมีนัยสำคัญในสคริปต์ขนาดเล็ก
รหัสในการพัฒนา, การอ่านควรได้รับการแนะนำ สคริปต์การผลิตขนาดใหญ่ควรจะลดขนาดลง