ウェブページ制作時のコードコメントの書き方

ウェブページ制作時のコードコメントの書き方
<br />私の仕事で使用しているアノテーションの書き方の基準をまとめました。技術的な内容はなく、制作方法を統一し、メンテナンスを円滑にするために使用しています。 「地域コメント」、「単一行コメント」、「コメント レベル」、「補助コメント」の 4 つの部分が含まれます。
ほとんどの学生は、「注釈コンテンツの開始」または「注釈コンテンツの終了」、「開始」または「終了」などで始まるエリア注釈の方法を使用します。これと比較して、「S」または「E」で始まる方法はより速く使用できます。たとえば、開始または終了コメントを 1 回記述し、それをコピーして「S」または「E」を変更するだけで、エリア注釈をすばやく完了できます。
エリア注釈<br />実際の作業では、注釈をラベルの上に置くべきか下に置くべきかが不明瞭になることがあります。このような状況を回避するために、注釈情報はエリアラベルの開始と終了の前後に統一して記述し、エリア注釈の開始または終了を示す「S」または「E」で始まります。
例:
<!--=S コメント内容-->
<div>
...
</div>
<!--=E コメント内容-->
/*=S コメント内容*/
。クラス{
...
}
。クラス{
...
}
/*=E コメント内容*/
1 行コメント<br />コメント情報は、コメントするコンテンツ領域に記述する必要があります。例:
<div>
<!--コメント内容-->
...
</div>
。クラス{
/*コメント内容*/
...
}
前のページ1 2 次のページ 全文を読む

<<:  MySQL 高可用性クラスタの展開とフェイルオーバーの実装

>>:  Apache SkyWalking アラーム設定ガイドの詳細な説明

推薦する

HTML テーブルタグチュートリアル (21): 行の境界線の色属性 BORDERCOLOR

テーブルを美しくするために、行ごとに異なる境界線の色を設定できます。基本的な構文<TR 境界線...

最新のmysql-5.7.21のインストールと設定方法

1. ダウンロードしたMySQLの圧縮パッケージをインストールディレクトリに解凍します。 2. 新し...

一般的な Linux の問題に対する解決策の概要

1. VMwareでCentos7を接続し、固定IPを設定する1) まず、仮想イメージ名を右クリック...

vue-cli 3 で vue-bootstrap-datetimepicker 日付プラグインを使用する方法

需要背景最近、Vue を使用してフロントエンド エンジニアリング システムと組み合わせ、以前のデモを...

zabbix を使用して ogg プロセスを監視する (Linux プラットフォーム)

以前作成されたデータベースの ogg プロセスは、発見されるまでの約半月間ダウンしていました。起動で...

HTML フォームタグチュートリアル (2):

このチュートリアルでは、ウェブデザインにおけるFORMフォームタグのさまざまな属性の応用を紹介します...

JavaScript の差異を利用して比較ツールを実装する

序文仕事では、毎週従業員が提出した資料を数える必要がありますが、それを一つずつコピーして貼り付けるの...

Ajax の JavaScript ソリューションにおける parsererror エラー ケースの詳細な説明

ajax の parsererror エラー (バックグラウンドからフロントエンドに送信される js...

MySQL が外部キーを作成できない理由と解決策

2 つのテーブルを関連付けるときに、外部キーを作成できませんでした。このブログから、問題は、ポイント...

JavaScript を使用してタイムラインとアニメーション効果を実装するためのサンプル コード (フロントエンドのコンポーネント化)

目次コードのクリーニングJavaScript の「フレーム」 「フレーム」の実装方法1. 間隔を設定...

CSS を使用して ul と li の水平配置を実現する 2 つの方法

li はブロックレベル要素であり、デフォルトで 1 行を占めるため、水平方向の配置を実現する場合は、...

リバースプロキシ設定を実装するためのユニバーサルnginxインターフェース

1. プロキシサーバーとは何ですか?プロキシ サーバーは、クライアントが要求を送信すると、それを直接...

MySQL 5.7.20 のインストールと設定方法のグラフィック チュートリアル (win10)

この記事では、MySQL 5.7.20のインストールと設定方法を参考までに紹介します。具体的な内容は...

画像の半透明処理 画像と半透明の背景の実装のアイデアとコード

コードをコピーコードは次のとおりです。 <!DOCTYPE html PUBLIC "...