Gaya pengkodean yang baik dapat membantu kita memiliki ide yang jelas saat membuat halaman web, dan komentar kode juga memiliki sedikit pengetahuan.
Saya merangkum standar penulisan anotasi yang saya gunakan dalam pekerjaan saya. Faktanya, tidak ada konten teknis. Yang utama adalah memperhatikan standar, yang memfasilitasi metode produksi terpadu dan memudahkan pemeliharaan.
Pengalaman ini mencakup empat bagian: "Komentar Wilayah", "Komentar Satu Baris", "Tingkat Komentar", dan "Komentar Terbantu". Metode anotasi area yang digunakan oleh sebagian besar teman akan dimulai dengan "konten anotasi" atau "konten anotasi akhir", "mulai" atau "akhir", dll. Sebagai perbandingan, memulai dengan "S" atau "E" bisa lebih cepat gunakan, misalnya, cukup tulis komentar awal atau akhir satu kali, lalu salin, dan ubah "S" atau "E" untuk menyelesaikan komentar di area tersebut dengan cepat.
Dalam pekerjaan sebenarnya, terkadang tidak jelas apakah anotasi harus berada di atas atau di bawah label. Untuk menghindari situasi ini, informasi anotasi ditulis secara seragam sebelum dan sesudah awal dan akhir label wilayah, dan diawali dengan "S". " atau
"
E" dimulai, menunjukkan awal atau akhir anotasi area.Contoh:
<!--=S konten komentar-->
<div>
...
</div>
<!--=E isi komentar-->
/*=S isi komentar*/
.kelas{
...
}
.kelas{
...
}
/*=E Konten komentar*/
komentar satu baris
harus ditulis di area konten yang perlu diberi komentar.
Contoh:
<div>
<!--Isi komentar-->
...
</div>
.kelas{
/*Isi komentar*/
...
}
Tingkat anotasi
Dalam produksi modul, mungkin terdapat area di dalam area. Untuk membedakan level antar area dengan lebih baik, konsep tingkat anotasi diperkenalkan. Tanda sama dengan di depan area komentar menunjukkan level komentar saat ini.
Contoh:
<!--=S konten komentar-->
...
<!--==S Konten komentar-->
...
<!--===S Konten komentar-->
...
<!--===E Konten komentar-->
...
<!--==E Konten komentar-->
...
<!--=E isi komentar-->
/*=S isi komentar*/
...
/*==S Isi komentar*/
...
/*===S isi komentar*/
...
/*===E Isi komentar*/
...
/*==E Isi komentar*/
...
/*=E Konten komentar*/
Membantu dalam mengomentari
informasi identifikasi seperti waktu modifikasi dan pengubah yang ditambahkan ketika dikelola oleh non-penulis. Tambahkan pengubah dan waktu modifikasi serta informasi lainnya berdasarkan komentar area atau komentar satu baris.
Contoh (komentar wilayah):
<!--==S konten komentar [pengubah dan waktu modifikasi]-->
<div>
...
</div>
<!--==E Konten komentar [pengubah dan waktu modifikasi]-->
/*=S Konten komentar [pengubah dan waktu modifikasi]*/
.kelas{
...
}
.kelas{
...
}
/*=E Konten komentar [pengubah dan waktu modifikasi]*/
Contoh (komentar satu baris):
<div>
<!-- Konten komentar [pengubah dan waktu modifikasi]-->
...
</div>
.kelas{
/*Isi komentar [pengubah dan waktu modifikasi]*/
...
}