フロントエンド開発におけるコードコメントの役割と使用法のデモンストレーション-htmlチュートリアル-php.cn

フロントエンド開発におけるコードコメントの役割と使用法のデモンストレーション

yulia

リリース： 2018-09-15 17:41:47

オリジナル

5529 人が閲覧しました

ページを書くとき、コメントは欠かせない部分です。コメントによってコードの構造が明確になる一方で、コードの引き継ぎが容易になります。もちろん、コードのコメントでも、標準化された方法で を使用する必要があります。そこで、今日はフロントエンドコードの アノテーションについてお話します。必要な方は参考にしていただければ幸いです。

1. コードコメントの用途は何ですか?

1. 実装する関数のガイドとなるアルゴリズムのアイデアを記述するのと同じ機能があります。次。ただ、疑似コードほど詳細ではありません。ただし、この機能を完成させるための一般的なアルゴリズムのアイデアも指摘されています。

2. コードを読む人に説明を書きます。コードを見るのは自分自身だけであることに注意してください。コードを見る人は、コードを読むたびにコードを 1 行ずつ読んで、何を書いたかを理解する必要がなく、すぐにコードを参照できるようになります。

2. コードコメントの仕様は、次の原則に従ってください。

1. 読者がコードのロジックと構造をよりよく理解できるようになります。

2.記述方法については説明できます。
3. 特別なマークのコメント: TODO、FIXME、その他の特別な意味を持つマークなど##4. ファイルのコメント: 一部の規則では、ファイルのヘッダーに固定形式のコメントを記述する必要があります。ファイル (作成者、プロトコル、その他の情報など)
5. ドキュメントコメント: 一部の規制では、ドキュメントコメント (jsdoc スタイルなど) を使用する必要があります。
6 などの統一されたスタイル仕様に従う必要があります。コメント自体を読みやすくするために、特定のスペースと空白行を追加します。

3. コードコメントの書き方

1. HTML コードコメント: ;

<!-- html中要注释的内容 -->
在web页面中，最常见的注释就是这种了。我们在布局页面结构的时候，会添加少许的注释方便我们查找与记忆我们的想法。
那么在页面中除了这样的注释外，还有那些注释呢，这里我列举一些：
If条件不同版本浏览器注释列表：
<!--[if !IE]>除IE外都可识别<![endif]--> 
<!--[if IE]> 所有的IE可识别 <![endif]-->
<!--[if gt IE 5.0]> IE5.0以及IE5.0以上版本都可以识别 <![endif]--> 
<!--[if IE 6]> 仅IE6可识别 <![endif]--> 
<!--[if lt IE 6]> IE6以及IE6以下版本可识别 <![endif]--> 
<!--[if gte IE 6]> IE6以及IE6以上版本可识别 <![endif]--> 
<!--[if IE 7]> 仅IE7可识别 <![endif]--> 
<!--[if lt IE 7]> IE7以及IE7以下版本可识别 <![endif]--> 
<!--[if gte IE 7]> IE7以及IE7以上版本可识别 <![endif]-->

ログイン後にコピー

2. CSS コードのコメント: /* コメントの内容*/

CSS のコメントは /*comments の形式になります。 css*/ で。コメント内容が 1 行または複数行になることはありません。

/*.aa,.bb {
                height: 100px;
                margin: 1px;
                background: #ccc;
            }*/

ログイン後にコピー

3. JS コードのコメント: //コメントの内容; または /* コメントの内容*/,

HTML\CSS とは異なり、JS のコメントには単一行と複数行の区別があります。 , かなり種類がありますので、以下で一つずつ紹介していきます。

(1) // 2 つのスラッシュは 1 行のコメントを表します。

(2)
(3) /* * / 複数行のコメント

//          function out(obj){
//              obj.innerHTML = "移出了";
//              obj.style.background = "#ccc";        
//          }

ログイン後にコピー

概要

: フロントエンド開発者は、コードコメントの目的と原則を深く理解し、コメント規則に従い、それらを組み合わせて使用する必要があります。ツールを使用すると、コメントがコードの可読性と保守性を向上させ、コードの品質を向上させることができます。

以上がフロントエンド開発におけるコードコメントの役割と使用法のデモンストレーションの詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。