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

ウェブページ制作時のコードコメントの書き方
<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 アラーム設定ガイドの詳細な説明

推薦する

VueコンポーネントライブラリElementUIはテーブルリストのページング効果を実現します

ElementUIはテーブルリストのページング効果のチュートリアルを実装しています。参考までに。具体...

Vueはログインタイプの切り替えを実装します

この記事では、ログインタイプの切り替えを実装するためのVueの具体的なコードを例として紹介します。具...

vueの実践的な応用におけるvuexの永続性の詳細な説明

目次vuex 永続性要約するvuex 永続性vuex: ブラウザを更新すると、vuexの状態は初期状...

HTML(divレイヤー)を介してFLASHにリンクを追加するための実装コード

今日、クライアントが広告を掲載したいのですが、提供された素材は Flash です。私たちはあまり気に...

MySQL の左結合操作における on 条件と where 条件の違いの紹介

優先度両方のケースで同じ条件を設定すると、異なる結果セットが生成される可能性があるのは、優先順位のた...

ファイルのアップロードの進行状況を示す React の例

目次React アップロードファイル表示の進行状況デモフロントエンドにReactアプリケーションを素...

js メモリ リークのシナリオ、それらを詳細に監視および分析する方法

目次序文どのような状況でメモリリークが発生する可能性がありますか? 1. 偶発的なグローバル変数2....

Vueの最初のプログラムを書くための勉強ノート

目次1. HTMLを書く、最初のVueプログラムビューテンプレートとデータに注意してください決定ルー...

MySQL インストール図の概要

MySQL 5.5 のインストールと設定方法のグラフィックチュートリアルMySQL 5.5 のインス...

Vueモバイル端末は左スライド編集と削除の全プロセスを実現します

序文プロジェクトのニーズに応じて、Vue-touch を使用して、vue モバイル端末の左スワイプ編...

Linux システムでのルート ディレクトリ拡張の概要

1. Linuxディスクの状態を確認する df -lh lsblkコマンドは、使用可能なすべてのブロ...

クラウド決済を実装するWeChatミニプログラムについて

目次1. はじめに2. 思考分析3. クラウド決済のケーススタディ1. クラウド機能1-1. 認証不...

CSSアニメーションに基づくSVGボタンのサンプルコード

具体的なコードは次のとおりです。 <a href="#"> <...

Raspberry Pi 4b ubuntu19 サーバーへの docker-ce のインストール手順

Raspberry Pi モデルは 4b、1G RAM です。システムはubuntu19.10サーバ...

HTML ページに SVG を挿入する複数の方法

SVG (Scalable Vector Graphics)は、XML 構文に基づいた画像形式です。...