優れたコーディング スタイルは、Web ページを作成するときに明確なアイデアを得るのに役立ちます。また、コードのコメントには小さな知識も含まれます。
私が仕事で使用したアノテーションの記述標準をまとめました。実際、主なことは、統一された作成方法とメンテナンスを容易にする標準に注意を払うことです。
これらのエクスペリエンスには、「領域コメント」、「単一行コメント」、「コメント レベル」、および「補助コメント」の 4 つの部分が含まれます。ほとんどの友人が使用する領域アノテーションの方法は、「アノテーション コンテンツ」または「アノテーション コンテンツ終了」、「開始」または「終了」などで始まります。それに比べて、「S」または「E」で開始する方が高速です。たとえば、開始コメントまたは終了コメントを 1 回書いてコピーし、「S」または「E」を変更するだけで、その領域内のコメントをすばやく完了できます。
実際の作業では、アノテーションをラベルの上に置くべきか下に置くべきかが曖昧になる場合があるため、これを避けるため、アノテーション情報は領域ラベルの先頭と末尾に「S」を付けて一律に記述します。 " または
"
E" で始まり、領域注釈の開始または終了を示します。例:
<!--=S コメントの内容-->
<div>
...
</div>
<!--=E コメント内容-->
/*=S コメント内容*/
。クラス{
...
}
。クラス{
...
}
/*=E コメント内容*/
コメントが必要なコンテンツ領域に、
1 行のコメント
コメント情報を記述します。例:
<div>
<!--コメント内容-->
...
</div>
.class{
/*コメント内容*/
...
}
アノテーション レベル
モジュールの作成では、エリア間のレベルをより適切に区別するために、アノテーション レベルの概念が導入されます。領域コメントの前の等号は、現在のコメントのレベルを示します。
例:
<!--=S コメント内容-->。
...
<!--==S コメントの内容-->
...
<!--===S コメントの内容-->
...
<!--===E コメントの内容-->
...
<!--==E コメントの内容-->
...
<!--=E コメント内容-->
/*=S コメント内容*/
...
/*==S コメント内容*/
...
/*===S コメント内容*/
...
/*===E コメント内容*/
...
/*==E コメント内容*/
...
/*=E コメント内容*/
作成者以外が保守する場合に追加された変更時刻や修飾子などの識別情報
のコメントを支援します
。領域コメントまたは単一行コメントに基づいて、修飾子、変更時刻、その他の情報を追加します。
例 (領域コメント):
<!--==S コメント内容 [変更子と変更時刻]-->
<div>
...
</div>
<!--==E コメント内容 [修飾子と修正時刻]-->
/*=S コメント内容 [修飾子と修正時刻]*/
。クラス{
...
}
。クラス{
...
}
/*=E コメント内容 [修飾子と変更時刻]*/
例（一行コメント）：
<div>
<!-- コメントの内容 [変更子と変更時刻]-->
...
</div>
.class{
/*コメント内容 [修飾子と変更時刻]*/
...
}