รูปแบบการเขียนโค้ดที่ดีสามารถช่วยให้เรามีแนวคิดที่ชัดเจนเมื่อสร้างหน้าเว็บ และความคิดเห็นเกี่ยวกับโค้ดก็มีความรู้เล็กๆ น้อยๆ เช่นกัน
ฉันสรุปมาตรฐานการเขียนคำอธิบายประกอบที่ฉันใช้ในงานของฉัน จริงๆ แล้วไม่มีเนื้อหาทางเทคนิคเลย สิ่งสำคัญคือการใส่ใจกับมาตรฐานซึ่งเอื้อต่อวิธีการผลิตแบบครบวงจรและอำนวยความสะดวกในการบำรุงรักษา
ประสบการณ์เหล่านี้ประกอบด้วยสี่ส่วน: "ความคิดเห็นของภูมิภาค" "ความคิดเห็นบรรทัดเดียว" "ระดับความคิดเห็น" และ "ความคิดเห็นที่ได้รับการสนับสนุน" วิธีการใส่คำอธิบายประกอบในพื้นที่ที่เพื่อนส่วนใหญ่จะเริ่มต้นด้วย "เนื้อหาคำอธิบายประกอบ" หรือ "ส่วนท้ายของเนื้อหาคำอธิบายประกอบ" "เริ่มต้น" หรือ "สิ้นสุด" เป็นต้น หากเปรียบเทียบแล้ว การเริ่มต้นด้วย "S" หรือ "E" จะเร็วกว่าถึง ใช้เช่นเพียงเขียนความคิดเห็นเริ่มต้นหรือสิ้นสุดเพียงครั้งเดียวจากนั้นคัดลอกและเปลี่ยน "S" หรือ "E" เพื่อแสดงความคิดเห็นในพื้นที่อย่างรวดเร็ว
ในการทำงานจริง บางครั้งก็ไม่ชัดเจนว่าคำอธิบายประกอบควรอยู่ด้านบนหรือด้านล่างป้ายกำกับ เพื่อหลีกเลี่ยงสถานการณ์นี้ ข้อมูลคำอธิบายประกอบจะถูกเขียนอย่างสม่ำเสมอก่อนและหลังจุดเริ่มต้นและจุดสิ้นสุดของป้ายกำกับขอบเขต และนำหน้าด้วย "S " หรือ
"
E" เริ่มต้น โดยระบุจุดเริ่มต้นหรือจุดสิ้นสุดของคำอธิบายประกอบพื้นที่ตัวอย่าง:
<!--=S เนื้อหาความคิดเห็น-->
<div>
-
</div>
<!--=E เนื้อหาความคิดเห็น-->
/*=S เนื้อหาความคิดเห็น*/
.ระดับ{
-
-
.ระดับ{
-
-
/*=E Comment content*/
ความคิดเห็นบรรทัดเดียว
ควรเขียนไว้ในพื้นที่เนื้อหาที่ต้องการแสดงความคิดเห็น
ตัวอย่าง:
<div>
<!--เนื้อหาแสดงความคิดเห็น-->
-
</div>
.คลาส{
/*เนื้อหาความคิดเห็น*/
-
-
ระดับคำอธิบายประกอบ
ในการผลิตโมดูล อาจมีพื้นที่ภายในพื้นที่ เพื่อให้แยกแยะระดับระหว่างพื้นที่ได้ดีขึ้น แนวคิดของระดับคำอธิบายประกอบจึงถูกนำมาใช้ เครื่องหมายเท่ากับด้านหน้าความคิดเห็นในพื้นที่ระบุระดับของความคิดเห็นปัจจุบัน
ตัวอย่าง:
<!--=S เนื้อหาความคิดเห็น-->
-
<!--==S เนื้อหาความคิดเห็น-->
-
<!--===S เนื้อหาความคิดเห็น-->
-
<!--===E เนื้อหาความคิดเห็น-->
-
<!--==E เนื้อหาความคิดเห็น-->
-
<!--=E เนื้อหาความคิดเห็น-->
/*=S เนื้อหาความคิดเห็น*/
-
/*==S เนื้อหาความคิดเห็น*/
-
/*===S เนื้อหาความคิดเห็น*/
-
/*===E เนื้อหาความคิดเห็น*/
-
/*==E เนื้อหาความคิดเห็น*/
-
/*=E เนื้อหาความคิดเห็น*/
ช่วยในการแสดงความคิดเห็น
ข้อมูลระบุตัวตน เช่น เวลาที่แก้ไขและตัวแก้ไขที่เพิ่มเข้ามาเมื่อผู้ที่ไม่ใช่ผู้เขียนเป็นผู้ดูแลรักษา เพิ่มตัวแก้ไขและเวลาในการแก้ไขและข้อมูลอื่นๆ ตามความคิดเห็นในพื้นที่หรือความคิดเห็นบรรทัดเดียว
ตัวอย่าง (ความคิดเห็นของภูมิภาค):
<!--==S เนื้อหาความคิดเห็น [ตัวแก้ไขและเวลาในการแก้ไข]-->
<div>
-
</div>
<!--==E เนื้อหาความคิดเห็น [เวลาแก้ไขและแก้ไข]-->
/*=S เนื้อหาความคิดเห็น [เวลาแก้ไขและแก้ไข]*/
.ระดับ{
-
-
.ระดับ{
-
-
/*=E เนื้อหาความคิดเห็น [เวลาแก้ไขและแก้ไข]*/
ตัวอย่าง (ความคิดเห็นบรรทัดเดียว):
<div>
<!-- แสดงความคิดเห็นเนื้อหา [ตัวแก้ไขและเวลาในการแก้ไข]-->
-
</div>
.คลาส{
/*เนื้อหาความคิดเห็น [ตัวแก้ไขและเวลาในการแก้ไข]*/
-
-