<！— open->なぜ多くの開発者がHTMLでこれを行うのですか？<！

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>

タグ/ペアの開始から遠いので、最後のはほぼ理解できます...しかし、真剣に、コメント行の開始のポイントは何ですか？私がこれをいつも見ていなかったとしても、私は質問しません。

何か足りないような気がします。多分それが何であるかもしれないかを理解するのに失敗しますが、含まれているいくつかの書かれていないベストプラクティスがあります。恐らくそれは強迫的行動だけです。

マークアップがあるとしたら、通常はどうやってコメントを付けますか？

comments html

— スティーブン
ソース

可能性の重複に：programmers.stackexchange.com/questions/4858/...

— クリス・

1

私はそれを始めると思います。

— Peter Turner、

1

この種のことはうまくいくと便利ですが、それらのコメントが関連するタグからしばらくして離婚し、実際には害よりも害が大きいことがわかりました。

— Rohan Singh

1

これはトートロジーであり、最悪の場合は危険なアンチパターンです。誰かがこの混乱を編集するとすぐに、コメントは現実と同期しなくなり、コメントがない場合よりも混乱します。適切なフォーマットと優れたIDEにより、この種のがらくたは役に立たなくなります。

1

私は推測する本当のいくつかの開発者は、このスタイルを好むかもしれない理由は、それが対称に見えるということです-平凡な開発者の多くは、これは本当に理にかなっているか、完全に脳死であれば考えを無駄にすることなく、対称コードを書くことを好みます。これは、「偶然のプログラミング」と呼ばれることもあります。

— Doc Brown

9

CSSクラス名が一般的で、具体的に名前が付けられない場合があります。たとえば、

<!--Code before-->



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




    <!--Tons of lines-->




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

何から始めたらいいの？div全体が列であることを確認するために最後までスクロールしたくありません。

— TheLQ
ソース

「オープニング」コメントが、IDまたは説明クラスでまだ識別されていないマークアップ要素を識別するためにのみ許容されます。

— スティーブン、

3

私が一番好きな冗長性だった私を気に何を推測する</form>と<div id="wrapper">

— スティーブン・

これは私が得ていたものであり、あなたの例はより明確にレイアウトされています。いい答えです！

— Chris

6

HTMLはコンパイルされたコードのようなものです。最適化されており、スペースやコメントはなく、仕事をしている間はできるだけ小さくなっています。ただし、HTMLファイルを生成するテンプレートにコメントがあります。ただし、開発チームに参加しないかぎり、それらは表示されません。

JavaScriptにも同じことが言えます。私のサイトで目にするJSはすべて圧縮、縮小され、コメントが削除されています。コメントは開発用であり、帯域幅の浪費ではありません。

— アンドリューク
ソース

4

通常、私のマークアップは動的に生成されるので、コメントは含まれません...しかし、マークアップを作成すると、次のようになります。

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

これにより、コード内の主要なブロック/ divがどこにあるかを簡単に確認できます。

— クリス
ソース

全くもって同じ意見です。

— エヴィックジェームズ

2

これは、適切なインデントのないドキュメントに由来するものだと思います。だから、あなたがいる列からどこにいるのかわからない場合は、次の最良のことはコメントを見ることです。このジレンマから進化したようです。

個人的には、コードをインデントしていない人たちに乗ることになります。

— Xeoncross
ソース

1

これについては、1つの有効な使用例、つまり部分的なHTMLテンプレートのみを考えることができます。

完全なHTMLページの場合は、要素を適切にインデントして、要素の開始と終了を簡単に識別できるようにする必要があります。まともな編集者は、タグの両端を強調表示します。これらの場合、無関係なコメントは迷惑です。

それが部分的なテンプレート（ヘッダーとフッターなど）の場合、ページコンテナーを開く場合は、フッターで終了する場所に表示すると便利です。

ヘッダ

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

フッター

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

このような（おそらくより複雑な）ケースでは、コメントがあると、どのタグが閉じることになっているのかを確認するのに非常に役立ちます。これは私がこれらのコメントを気にしないで出くわした唯一のケースですが、それでもまだ汚れています。

— エイドリアン・シュナイダー
ソース

はい、ビューやテンプレートのようなものでは、各セグメントがそのファイルの特定のコードのみにインデントされることが多いため、これはしばしば問題を引き起こします。

— Xeoncross、2012年

1

これは、ページが複数の異なるファイル/テンプレートなどによってレンダリングされる場合に役立ちます。

このようなもの：

<?php

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

そうすることで、レンダリングされたHTMLに異常が見られた場合、それを作成したコードをすばやく追跡できます。

— タイラール
ソース

<！— open->なぜ多くの開発者がHTMLでこれを行うのですか？<！— /閉じる->