JSコードのアノテーション方法とコードアノテーションの仕様についての深い理解

ページのレイアウト中、コードの読みやすさを向上させるために、コードにコメントを追加することが必要になることがよくあります。この記事では、JS コードに注釈を付ける方法と、JS コードのコメントの仕様について説明します。参考にしていただければ幸いです。

コメントはコードの重要な部分であり、完全なプログラムにはコメントを付ける必要があります。コメントは、プロジェクトの更新や変更に役立つだけでなく、他の人がプロジェクトを入手したときに、あなたが何を書いたかを知るのにも役立ちます。

1. JavaScript コードのコメント方法

JavaScript は、コメント内のコードを実行しません。JS コードのコメントは、単一行のコメントと複数行のコメントに分かれています。ラインコメント。

1. 単一行コメント

// で始まり、// の後にスペースを追加してコメントの内容を記述することができます。現在のコードの機能を説明し、コードなどを説明します。

コード例: ページに表示する必要なしに document.write("String is:" str) コードの 1 行をコメント化します。

<script type="text/javascript">
  function myFunction(){
   var animal = ["dog", "cat", "elephant", "tiger"];
   var str=animal.toString();
   document.write("类型是："+typeof(str));  
   //document.write("字符串是:"+str)
  }  
 </script>

コメント前のレンダリング:

コメント後のレンダリング:

2. 複数行のコメント

複数行のコメントは / で始まります。 * と最後に */ を付けますが、複数行のコメントではなく、単一行のコメントを使用するようにしてください。ただし、コメントに複数行が必要な場合でも、単一行のコメントで完了する必要があります。関数のコメントには複数行のコメントを使用することをお勧めします。

コード例:

<script>
/*
下面的这些代码会输出
一个标题和一个段落
并将代表主页的开始
*/
document.getElementById("myH1").innerHTML="欢迎来到菜鸟教程";
document.getElementById("myP").innerHTML="这是一个段落。";
</script>

2. JS コード コメントの仕様

コード コメントが適切でない場合は、適切なコメントを作成する必要があります。コメントを追加する必要がある場合は、他の人が意味を理解できるように詳細に記述し、コードの明確さと読みやすさを向上させるようにしてください。作業中に次の点を達成する必要があります:

1. 論理コードでは、コード コメントが 20% 以上である必要があります。

2. ファイル コメントが作成されるときは、ファイル コメントをヘッダー

3. クラスとインターフェイスにコメントする場合、クラス属性、パブリック メソッド、および保護されたメソッドを使用する場合は、コメントをクラスの前とパッケージの後に配置する必要があります。 , コメント クラス属性、パブリックメソッド、プロテクトメソッドに記述する必要があります。つまり、// コメントを使用します。これは、コメント化されたコード

5 と一致する必要があります。コメントは、コメント化されたコードの前に配置し、別の行に記述する必要があり、途中に空白行を残さないでください。

6. 省略語を使用する場合は、メンバー変数の内容に必要な説明を付ける必要があります。メンバー変数の意味、目的、機能、およびそれらが使用される場合は、// を使用してください。 コメントは、コメントされたコードを整列させる必要があります。

つまり、すべてのプログラマーは、コメントを書く良い習慣を身につけるべきです。これにより、自分自身がコードを読んだり変更したりすることが容易になるだけでなく、他の人がコードを理解し、保守することも容易になります。

上記は、JS コードのアノテーション方法と JS コードのアノテーション仕様を紹介しています。その他の関連チュートリアルについては、

#

以上がJSコードのアノテーション方法とコードアノテーションの仕様についての深い理解の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。