html、css、jsのアノテーション仕様の使用方法まとめ

必要なコメントを追加することは、責任感のある倫理的なフロントエンドが持つべき良い習慣であり、コードの保守性と可読性を大幅に向上させることができます。まず最初に、html、css、jsのコメントの書き方に慣れる必要があります。

htmlのコメントです。

<未定義

cssのコメントです。

//コメント内容 一行コメント（ブラウザによっては互換性がなく、効果がない場合があるので推奨しません。）
/*コメント内容*/ 複数行コメント(推奨)

JavaScriptです。

//コメント内容 一行コメント
/*コメント内容*/ 複数行のコメント

概要を説明します。

//コメント内容（cssやjavascriptで1行コメントを挿入します。）
/*コメント内容*/ (cssまたはjavascriptで複数行のコメントを挿入)

次に、このようなコードの中でコメントが使われる場所と、その書き方をまとめます。(個人の癖によって違うかもしれませんが）。

1. htmlコメント

使用場所

1) 一般に、いくつかの主要なノードタグの末尾の後に使用される。

<div class="wrap">
<div class="main">
...
</div><! --main end-->
<div><! --wrap end-->

2) いくつかのループの終わりの後に使用する，例．

<ul class="list">
    <li>111111</li>
    <li>22222222</li>
    <li>33333333</li>
</ul><! --list loop-->

これらはすべて、ネストする際にプログラムをより便利に、より分かりやすくするためです。それは他の人にとっても便利ですし、自分自身にとっても便利です。もし、プログラムがごちゃごちゃとネストされていたら、それを修正するのは複雑な作業になります。

2、CSSコメント

は一般に、上部のモジュール スタイルの定義で使用され、この段落スタイルがどのモジュールの役割であるのかを示します。

/*general - comment*.comment{...}
/*album*.photo{...}
/*share*.share{...}
/*vote*.vote{...}

3. javascriptのコメント

一般に、機能関数の先頭には、関数、作者、作者情報、修正時刻を記載したコメントを追加します。

// ========================================================
// truncated characters
// steepvi
// rtx:*******
// 2010-10-14
// ========================================================

最後に、コメントも文字がトラフィックを生む。そのため、公式アドレスにページを公開する際は、最適化するためのステップを追加するのがベストです。

圧縮処理は非可逆的で、ローカルのファイルを確実に最新にし、注釈を付けて圧縮し、サーバーにアップロードします。サーバー側のファイルは、ローカルでのデバッグには使用できません。

以上、html、css、jsのアノテーション仕様の使い方をまとめてみました、参考になれば幸いです、何か質問があれば、メッセージを残してください、タイムリーに返信します。皆様、スクリプトハウスのウェブサイトをどうぞよろしくお願いいたします。