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

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

<div>
...
</div>

/*=S コメント内容*/
。クラス{
...
}
。クラス{
...
}
/*=E コメント内容*/
1 行コメント<br />コメント情報は、コメントするコンテンツ領域に記述する必要があります。例:
<div>

...
</div>
。クラス{
/*コメント内容*/
...
}

前のページ1 2 次のページ全文を読む

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

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

kubernetes1.5.2 から kubernetes1.10 にアップグレードする際の主要な設定変更記録

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

kubernetes1.5.2 から kubernetes1.10 にアップグレードする際の主要な設定変更記録

よく使われる Docker コマンドと例の概要と分析

Vueは商品詳細ページの商品タブ機能を実装します

MySQLにおける遅いSQLの最適化の方向性について詳しく話しましょう

Vueプロジェクトでのトークン検証ログイン（フロントエンド部分）

デザインにおいて無視できないインタラクティブデザインにおける製品状態の分析

ServerSocketのデフォルトIPバインディングの実装プロセスの詳細な説明

MySQL での %% のようなファジークエリの実装

docker-compose でデプロイしたときに MySQL にアクセスできなくなる問題の簡単な分析

CSS3アニメーション属性に基づくWeChatタップアニメーション効果の実装

推薦する

Thinkpad VMware に仮想マシンをインストールすると、「このホストは Intel VT-x をサポートしていますが、Intel VT-x は無効になっています」というメッセージが表示される (問題解決)

Vue3 を使用してアップロードコンポーネントを実装するためのサンプルコード

reactにおけるstateの略語の詳細な説明

CSS3 のテキストとフォントの新しい設定

ページ内にマーキーとフラッシュが共存する場合の競合解決

Vueはvueメタ情報を使用して各ページのタイトルとメタ情報を設定します。

CSSメディアクエリのアスペクト比を小さくする方法

mysql8.0.19 の基本データ型の詳細な説明

Nginx を使用してクロスドメイン Vue 開発環境を処理する方法

JavaScript の遅延読み込み属性パターンを理解する

Docker クリーニングの一般的な方法と問題点

MySQL で日付を保存するためのベストプラクティスガイド

SQL 文における複合主キーと結合主キーに関する予備的研究

MySQL テーブル内の重複データを検索して削除する方法の概要

MySQL セキュリティ管理の詳細