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

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

推薦する

フレームセットの共通プロパティ(フレームとウィンドウの分割)

フレームとは、Web ページ画面を複数のフレームに分割したもの(複数の Web ページという形で表示...

MySQL アップグレードのベストプラクティス

MySQL 5.7 には、オンライン DDL、マルチソース レプリケーション、拡張された半同期、テー...

Windows 上の MySQL 5.6 で my.ini 設定ファイルを見つける方法

忘れてしまった場合に後で戻って確認できるようにメモしておいてください。問題の説明:今日はちょっとした...

CocosCreatorでスワイプした位置にテクスチャを表示する方法

目次1. プロジェクト要件2. 文書の内容3. プロジェクト例4. プロジェクトコード1. プロジェ...

Chrome 73 によるフレックスレイアウトの崩れの解析と解決方法

現象プロジェクトにはネストされたフレックス構造がいくつかあります。 <スタイル> /* ...

Vueでeslintを使用する方法の詳細な説明

目次1. 説明2. 関連する依存パッケージをダウンロードする3. 設定ファイル .eslintrc....

Dockerデータを完全にクリーンアップする方法

目次定期的に剪定するミラーエビクションコンテナのクリーンアップネットワークソート体積の蒸発完全にクリ...

CentOS 8にdockerをインストールする最も詳細な方法

CentOS 8にDockerをインストールする公式ドキュメント: https://docs.doc...

Ubuntu 18.04 コマンドでタッチパッドを無効/有効にする

Ubuntu では、ショートカット キーでタッチパッドをオフにできない状況によく遭遇します。この問題...

怖いハロウィーン Linux コマンド

ハロウィーンではありませんが、Linux の不気味な側面に注目する価値はあります。幽霊、魔女、ゾンビ...

Vueは新しいウィンドウを開き、パラメータ転送のグラフィック例を実装します。

私が実現したい機能は、新しいウィンドウを開いて新しいページを表示することですが、パラメータを渡す必要...

CSS3で実装されたスライドメニュー

結果:実装コード: <!DOCTYPE html><html class=&quo...

Vue実装のカウンターケース

この記事では、カウンター表示を実現するためのVueの具体的なコードを例として紹介します。具体的な内容...

MySql 5.7.17 winx64 のインストールと設定に関する詳細なチュートリアル

1. ソフトウェアをダウンロードする1. MySQL の公式サイトにアクセスし、Oracle アカウ...

Eclipse は Tomcat を構成しますが、Tomcat には無効なポート解決策があります

目次1. EclipseがTomcatを構成する2. Tomcat の無効なポートの解決方法方法1:...