Change language
Python.Engineering Wiki HTMLでJavascriptをコメントする

HTMLでJavascriptをコメントする

__del__ | __main__ Python module | code Python module | COM PHP module | DBA PHP module | dis Python module | Ev PHP module | exp | html Python module | imp Python module | io Python module | JavaScript | os Python module | PS PHP module | Python Development | Python functions | re Python module | sep | SPL PHP module | StackOverflow | time Python module | types Python module | UI PHP module
Michael Zippo Michael Zippo

HTMLコメントを書き込むには <--- および ！ ---> コメントの両端。 HTMLコメントは、HTMLコードを整理しておくことが知られており、ブラウザによって無視されます。

ドキュメントソフトウェアの最も重要な側面の1つは、コードに書かれたコメントです。コメントは、インタプリタやコンパイラによって無視され、人間が読むことを目的としたコンピュータプログラムに存在する行です。

コメントを書き込むと、コードを読みやすくし、の特定の部分の内容を示すことができます。作られたプログラム。たとえば、長いプログラムを作成している場合は、コメントを使用して特定の関数やコード行を追跡できます。

このチュートリアルでは、HTMLでコメントを作成する方法について説明します。まず、プログラミングでコメントが使用される理由を見ていきます。次に、2つの主要なタイプのコメントを見ていきます。 1行のコメントと複数行のコメント

開発者がコメントを書く理由

HTMLでは、コメントは無視されますか？ブラウザによって、コードがコンパイルおよび縮小されると削除されます。では、なぜレビューを書くのでしょうか？

コメントは、人間が読みやすく、コードを理解しやすくするために書かれています。単一のプロジェクトで作業している場合、コードを読んでいるのはあなただけなので、コメントをスキップするのは簡単です。ただし、複雑なコードを含む大規模なプロジェクトで作業している場合は、コードの目的を見失う可能性があります。

また、チームで作業している場合、他の人がコードを理解できない可能性があります。あなたが書いた。この場合、特定のコードの目的を見つけるためにフォローしなければならない場合や、コードの意味と機能を理解せずにコード行をスキップする場合があります。

を使用した新しいHTML行

コメントは、開発者に多くの利点を提供します。まず、すでに説明したように、コメントを使用するとコードが理解しやすくなります。コードにコメントを書くと、コードを読んだあなたや他の人は、コードの特定のポイントで何が起こっているかを追跡しやすくなります

次に、コメントを使用すると、開発者はプログラムに関する決定の背後にある理由を説明できます。これは、プログラムが機能を停止してバグ修正が必要な場合や、開発者が理由をより明確にする必要がある場合に役立ちます。問題を解決するために特定のアプローチが使用されました。コメントは、コードを理解しやすいため、開発プロセスのスピードアップにも役立ちます。

HTMLコメント

HTMLでのコメントドキュメントは特別な矢印で囲まれ、プログラムの他の部分から分離されています。コメントはブラウザに表示されません。基本的なHTMLコメントタグの構文は次のとおりです。

Webページを開いているとき、このコードはn otは私たちのウェブページに表示されます。これの代わりに、コードは読み取り用のソースコードに表示されます。

上記の例は1行のコメントです。つまり、テキストは1行にのみ表示されます。このタイプのコメントは、コメントが短い場合に役立ちます。ただし、長いコメントを書き込む場合は、複数行コメントを使用する必要があります。

複数行の構文は単一行コメントの場合と同じですが、コメントの違いが異なります。新しいファームライン上にあります。複数行のコメントタグの構文は次のとおりです。

HTMLコメントの使用

HTMLコメントの書き方がわかったので、疑問に思うかもしれません。コードにコメントを追加するのはいつですか。フィードバックをいつ使用するかについての厳密なガイドラインはなく、各開発者とチームには独自の好みがありますが、覚えておくべきことがいくつかあります。

コメントは一般的に使用する必要があります：

もちろん、コードにコメントを追加できる状況は他にもありますが、これらが最も一般的です。

さらに、を使用することもできます。 HTMLタグブロックにコメントするためのHTMLコメント。これにより、プログラムにコード行を保持できますが、HTMLWebページがレンダリングされるときにそれを無視するようにブラウザに指示します。

プログラム外のコードにコメントするデバッグ時には、問題の原因を見つけて解決策を実装する必要があるため、デバッグ時には一般的です。プログラムからコードを完全に削除せずに、コードを無視するようにプログラムに指示すると役立つ場合があります。例を次に示します。 HTMLコメントを使用してコードにコメントを付ける方法：

は段落の例です。

<！ ---

これは別の例、段落です。

--->

ブラウザがこのコードをレンダリングする場合、2番目の段落は無視されます。コメントに含まれています。

HTMLコメントは便利ですが、プログラムに付加価値を与える場合にのみ使用してください。プログラムのすべての機能を説明したり、意味のある方法で引数を説明したりするためにコメントを追加する必要はありません。 HTMLコメントを書くときに覚えておくべきいくつかのヒントを次に示します。

  • 既存のコードを再定式化しないでください。コメントは、プログラムの意図や論理を説明するために使用されます。英語のコードですでに書かれていることを宣言するためにコメントを使用しないでください。
  • 長いコメントを書かないでください。開発者は、複雑な手順を説明する長いレビューを書きたくなることがよくあります。ただし、長いコメントが役立つ場合もありますが、慎重に使用する必要があります。これの代わりに、一番下に説明しなければならない機能がある場合は、ドキュメントエントリを作成することをお勧めします。
  • すべてを説明しないでください。コメントはプログラムを明確にするために使用され、コメントが多すぎるとメインコードの邪魔になる可能性があります。明らかなことがあれば、コメントは必要ありません

結論

コメントの使用HTMLは、思い出させるのに役立ちますあなたとあなたのコードを読む他の人の両方にとってprogはより読みやすくなります。あなたのコードにコメントを書くと、他の人があなたのコードの背後にある意図を理解しやすくなります。

このチュートリアルでは、コメントの基本とHTMLでコメントを作成する方法。また、コメントが役立つ理由についても説明し、コメントを効果的に書き込むためのベストプラクティスを検討しました。ただし、各開発者には独自のコメントスタイルがあり、他のコメントを書くとわかります。

これで、エキスパートのようにHTMLコメントを作成する方法がわかりました。