<! - buka -> Mengapa begitu banyak pengembang melakukan ini dalam HTML mereka? <! - / tutup ->

8 
 <body>  
  <!-- wrapper -->  
  <div id="wrapper"> 
   <!-- title -->
   <div id="title"><img src="title.png" alt="" /></div>

   <!-- form wrapper -->
   <div id="form_wrapper">

    <!-- form -->
    <form action="thankyou.php" method="POST">
     <!-- ... ... -->
    </form>
    <!-- /form -->
   </div>
   <!-- /form wrapper -->
  </div>
  <!-- /wrapper -->
 </body>

Saya hampir dapat memahami <!-- /wrapper -->pada akhirnya, karena itu jauh dari awal tag / pasangan ... tapi serius, apa gunanya baris komentar pembuka? Saya tidak akan mengajukan pertanyaan jika saya tidak melihat ini sepanjang waktu .

Aku merasa seperti kehilangan sesuatu. Mungkin ada beberapa praktik terbaik tidak tertulis yang terlibat, meskipun saya gagal memahami apa yang mungkin terjadi. Kemungkinan besar itu hanya perilaku obsesif-kompulsif.

Bagaimana kalian biasanya berkomentar markup Anda, jika sama sekali?

comments html Stephen
sumber
kemungkinan duplikat ke: programmers.stackexchange.com/questions/4858/…
Chris
1
Saya pikir saya akan mulai melakukan itu.
Peter Turner
1
Sementara hal semacam ini bisa berguna ketika berfungsi, saya telah melihat komentar-komentar itu bercerai dari tag terkait mereka setelah beberapa saat, dan kemudian mereka benar-benar melakukan lebih banyak kerusakan daripada kebaikan.
Rohan Singh
1
ini adalah tautologi yang paling baik dan berbahaya yang berpola buruk, begitu seseorang mengedit kekacauan ini, komentar akan keluar dari sinkronisasi dengan kenyataan dan menjadi lebih berantakan daripada tanpa mereka. Pemformatan yang tepat dan IDE yang bagus membuat sampah seperti ini tidak berguna!
1
Saya kira alasan sebenarnya mengapa beberapa devs lebih suka gaya ini adalah karena terlihat simetris - banyak devs biasa-biasa saja lebih suka menulis kode simetris tanpa membuang-buang pikiran jika ini benar-benar masuk akal atau sepenuhnya braindead. Ini kadang-kadang disebut "pemrograman secara kebetulan".
Doc Brown

Jawaban:

9

Beberapa kali nama kelas CSS adalah generik dan tidak disebutkan secara spesifik. Misalnya, bagaimana jika Anda punya

<!--Code before-->



<!--Column one-->
<div class="center-bold">




    <!--Tons of lines-->




</div>
<!--End column-->

Tidakkah menyenangkan mengetahui awal Anda? Saya pasti tidak ingin menggulir sampai ke ujung untuk mengetahui bahwa seluruh div adalah kolom.

TheLQ
sumber
Hanya dapat diterima karena komentar "pembukaan" mengidentifikasi elemen markup yang belum diidentifikasi dengan ID atau kelas deskriptif.
Stephen
3
Saya kira apa yang paling mengganggu saya adalah pengulangan </form><!-- /form -->dan<!-- wrapper --><div id="wrapper">
Stephen
Inilah yang saya maksudkan, contoh Anda hanya ditata secara lebih eksplisit. Jawaban yang bagus!
Chris
6

HTML seperti kode yang dikompilasi untuk saya. Ini dioptimalkan, tidak memiliki ruang, tidak ada komentar, dan sekecil mungkin sambil menyelesaikan pekerjaan. Namun, saya punya beberapa komentar di templat saya yang menghasilkan file HTML. Anda tidak akan pernah melihatnya, kecuali jika Anda bergabung dengan tim dev!

Hal yang sama berlaku untuk JavaScript. JS apa pun yang Anda lihat di situs saya dikompresi, diperkecil, dan dihapus komentarnya. Komentar untuk pengembangan, bukan untuk membuang-buang bandwidth!

andrewrk
sumber
4

Biasanya markup saya dihasilkan secara dinamis sehingga komentar tidak termasuk ... tetapi ketika saya menulis markup saya akan memiliki:

<!-- start BLOCK--> 
  html markup 
<!-- close BLOCK-->

Itu membuatnya lebih mudah bagi saya untuk melihat di mana blok / div utama berada dalam kode saya.

Chris
sumber
Saya sangat setuju.
Evik James
2

Saya percaya ini berasal dari dokumen yang tidak memiliki indentasi yang tepat. Jadi, jika Anda tidak tahu di mana Anda berada di kolom tempat Anda berada - maka hal terbaik berikutnya adalah melihat komentar. Tampaknya telah berevolusi dari dilema ini.

Secara pribadi, saya akan mendapatkan pada orang yang tidak membuat indentasi kode

Xeoncross
sumber
1

Saya hanya bisa memikirkan satu kasus penggunaan yang valid untuk ini: sebagian template HTML.

Jika halaman HTML lengkap, maka Anda harus membuat indentasi dengan benar untuk memudahkannya mengidentifikasi kapan elemen mulai dan berakhir. Editor yang layak juga menyoroti ujung-ujung yang berlawanan dari tag. Dalam kasus-kasus ini, komentar-komentar asing mengganggu.

Jika itu adalah sebagian template (header dan footer, misalnya), maka jika Anda membuka beberapa kontainer halaman, mungkin berguna untuk ditampilkan di footer di mana ia berakhir.

tajuk

<div id="header">
    ...
</div>
<div id="contentContainer">
    <div id="content">

footer

    </div> <!-- /#content -->
</div> <!-- /#contentContainer -->
<div id="footer">
    ...
</div>

Dalam kasus (mungkin lebih kompleks) seperti ini, memiliki komentar cukup membantu untuk melihat tag apa yang seharusnya ditutup. Ini adalah satu-satunya kasus saya menemukan di mana saya tidak keberatan komentar ini, meskipun, mereka masih merasa kotor.

Adrian Schneider
sumber
Ya, dengan hal-hal seperti tampilan dan templat, hal ini sering menimbulkan masalah karena setiap segmen hanya di-indentasi ke kode spesifik file tersebut.
Xeoncross
1

Ini berguna jika halaman dirender oleh beberapa file / templat yang berbeda, dll.

Sesuatu seperti ini:

<?php

echo "<!-- sidebar -->\n";
include("sidebar.php");  
echo "<!-- /sidebar -->";
# Or better yet, put the HTML comments *inside* sidebar.php
?>

Dengan begitu jika Anda melihat beberapa keanehan dalam HTML yang Anda buat, Anda dapat dengan cepat melacak kode yang membuatnya.

tylerl
sumber