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

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

推薦する

MAC 上の MySQL の初期パスワードを忘れた場合の対処方法

MACでMySQLの初期パスワードを忘れた場合の解決策を参考までに共有します。具体的な内容は次のとお...

htmlダウンロード機能の詳しい説明

新しいプロジェクトは基本的に終了しました。フロントエンドとバックエンドを分離して統合を完了したのは初...

Linux で測位バックグラウンド サービスが時々クラッシュする問題の解決方法

問題の説明最近のバックグラウンドサービスでは、特定の命令の要求データをディスクに保存する新しい機能が...

CSS における位置指定の概要

CSS には 4 種類の配置方法があり、シナリオによって効果が異なります。ここでは、これら 4 種類...

Nginx が Apache より優れている理由

Nginx は、わずか数年で Web サーバー市場の大部分を占めるようになりました。周知のとおり、N...

JSはキャンバス技術を使用してeChartsの棒グラフを模倣します

Canvas は HTML5 の新しいタグです。js を使用して Canvas 描画 API を操作...

js における浅いコピーと深いコピーの詳細な説明

目次1. jsメモリ2. 譲渡3. 浅いコピー4. ディープコピー序文:以下の記事を読む前に、記憶に...

LinuxにMySQLデータベース5.6のソースコードをインストールし、ログインユーザーのパスワードを変更する

この記事では、主に Linux で MYSQL データベースをインストールする方法について説明し、M...

CSS で平均レイアウトを実現するために負のマージンを使用する例

均等に分散されたレイアウトの場合、通常はネガティブ マージン方式を使用します。次の図は平均的なレイア...

JavaScript ではおそらく switch 文を使う必要はない

目次スイッチも複雑なコードブロックもありませんPythonからのインスピレーション辞書を使用してスイ...

テーブル切り替えのための JavaScript プラグインのカプセル化

この記事では、テーブル切り替えプラグインを実装するためのJavaScriptのカプセル化コードを参考...

Linux 7.7 でスワップ パーティション SWAP を設定する方法

Linux システムの Swap パーティション、つまり swap パーティションは、一般に仮想メモ...

Linux で XFS パーティション形式のルート ディレクトリを縮小する方法

目次序文システム環境現在のシステムパーティションレイアウトデータのバックアップレスキューモードに入る...

Nginx の break と last の違いの詳細な分析

まずは違いについて話しましょう最後に、書き換えられたルールは、次の場所と一致させるために書き換えられ...

MySQL ALTERコマンドの知識ポイントのまとめ

テーブル名を変更したり、テーブル フィールドを変更したりする必要がある場合は、 MySQL ALTE...