Apabila anda melihat halaman web dalam pelayar, anda akan melihat gambaran visual tentang apa yang perisian tersebut (penyemak imbas web) dipaparkan berdasarkan kod halaman web tertentu. Jika anda melihat kod sumber halaman web, anda akan melihat dokumen yang terdiri daripada pelbagai elemen HTML, termasuk perenggan, tajuk, senarai, pautan, imej dan banyak lagi. Semua elemen ini diberikan oleh pelayar pada skrin pelawat sebagai sebahagian daripada paparan laman web. Satu perkara yang mungkin anda dapati dalam kod HTML yang tidak diberikan pada skrin seseorang adalah apa yang dikenali sebagai "komen HTML".
Apa komen?
Ulasan adalah rentetan kod dalam HTML, XML, atau CSS yang tidak dilihat atau diambil oleh penyemak imbas atau parser. Ia hanya ditulis dalam kod untuk memberikan maklumat tentang kod atau maklum balas yang lain daripada pemaju kod.
Kebanyakan bahasa pengaturcaraan mempunyai komen, mereka biasanya digunakan oleh pemaju kod untuk satu atau lebih daripada satu, sebab berikut:
- Terangkan dan terangkan kod rumit kepada seseorang yang mungkin perlu bekerja di masa depan - termasuk diri mereka sendiri! Mereka boleh kembali ke kod 3 atau 6 dari 12 bulan atau lebih kemudian dan tidak ingat mengapa mereka melakukan sesuatu dengan cara tertentu. Komen boleh membantu menjawab soalan mereka dan mengingatkan mereka tentang fikiran mereka ketika mereka mula-mula mengembangkan halaman itu.
- Berikan butir-butir tentang kapan kod itu disunting atau dikaji semula. Ini boleh menjadi maklumat yang berguna dan bertindak agak seperti log pembangunan ketika tapak terakhir berfungsi.
- Keluarkan bahagian kod, tetapi biarkannya tersedia untuk kegunaan kemudian. Ini sering dilakukan semasa ujian tapak dan debugging. Sekiranya anda mempunyai masalah di laman web dan tidak pasti apa yang menyebabkannya, anda boleh memberi komen bahagian sekaligus untuk meng kuarantin dan mengenal pasti isu itu, dan kemudian lakukan pembetulan untuk sebarang masalah yang anda alami.
- Berbual dengan pemaju lain yang bekerja pada kod. Ini mungkin dilakukan semasa pembangunan sebagai cara untuk berkongsi butiran dengan orang lain yang bekerja pada kod pada masa yang sama. Jika komen-komen ini semata-mata perbualan pembangunan, itu adalah amalan terbaik untuk membuangnya daripada kod sebelum tapak dilancarkan.
Secara tradisinya, komen dalam HTML digunakan untuk hampir mana-mana unsur, dari penjelasan struktur meja kompleks hingga ucapan bermaklumat kandungan halaman itu sendiri. Oleh kerana komen tidak diberikan dalam penyemak imbas, anda boleh menambahkannya di mana saja di HTML dan tidak mempunyai kebimbangan mengenai apa yang akan dilakukannya apabila laman web itu dilihat oleh pelanggan.
Cara Menulis Komen
Menulis komen dalam HTML, XHTML, dan XML sangat mudah. Lekatkan teks yang anda mahu mengulas dengan yang berikut:
dan
Seperti yang anda lihat, komen ini bermula dengan "kurang daripada simbol", ditambah dengan tanda seru dan dua tanda. Komen itu berakhir dengan dua lagi tanda dan "lebih besar daripada: simbol. Antara watak-watak tersebut, anda boleh menulis apa sahaja yang anda mahu membentuk badan komen.
Dalam CSS, ia agak berbeza, menggunakan komen kod C daripada HTML Anda bermula dengan slaid ke hadapan diikuti oleh asterisk. Anda mengakhiri ulasan dengan sebaliknya, asterisk yang diikuti dengan slaid ke hadapan.
Komen adalah Art Dying
Kebanyakan pengaturcara mengetahui nilai komen berguna. Kod yang dikemukakan memudahkan kod tersebut dipindahkan dari satu pasukan kepada yang lain. Komen membantu anda pasukan QA untuk menguji kod itu kerana mereka boleh mengetahui apa yang dikehendaki oleh pemaju - walaupun ia tidak dicapai. Malangnya, dengan populariti platform pengarang laman web seperti Wordpress, yang membolehkan anda bangun dan berjalan dengan tema pilihan yang mengendalikan banyak, jika tidak semua, HTML untuk anda, komen tidak digunakan seringkali oleh pasukan web. Ini kerana komen sangat sukar untuk dilihat dalam kebanyakan alat pengarangan visual jika anda tidak bekerja secara langsung dengan kod. Contohnya, bukannya melihat, di bahagian atas laman web:
Alat visual menunjukkan ikon kecil untuk menunjukkan bahawa ada komen. Sekiranya pereka tidak memberi komen secara fizikal, dia tidak akan dapat melihatnya. Dan dalam hal halaman di atas, boleh menyebabkan masalah jika dia mengedit halaman dan penyuntingan itu ditulis dengan lebih tertulis oleh naskah yang disebutkan di dalam komentar.
Apa yang boleh dibuat?
- Tulis komen yang bermakna dan berguna. Jangan mengharapkan orang lain membaca komen anda jika terlalu lama atau tidak memasukkan maklumat yang berguna.
- Sebagai pemaju, anda sepatutnya sentiasa semak sebarang komen yang anda lihat pada halaman.
- Gunakan alat yang disediakan oleh program pengarang yang membolehkan anda menambah komen.
- Gunakan pengurusan kandungan untuk mengawal bagaimana halaman diedit.
Walaupun anda satu-satunya orang yang mengedit laman web anda, komen boleh berguna. Jika anda hanya mengedit halaman rumit sekali setahun, mudah lupa cara anda membina meja atau menggabungkan CSS. Dengan komen, anda tidak perlu ingat, kerana ia ditulis di sana untuk anda.
