JS 코드 주석 방법 및 코드 주석 사양에 대한 심층적인 이해

페이지 레이아웃 중에 코드의 가독성을 높이기 위해 코드에 주석을 추가해야 하는 경우가 많습니다. 이 기사에서는 JS 코드에 주석을 추가하는 방법과 관심 있는 친구들이 참조할 수 있는 JS 코드 주석 사양에 대해 설명합니다. 도움이 되었기를 바랍니다.

댓글은 코드의 필수적인 부분입니다. 완전한 프로그램에 댓글을 달아야 합니다. 댓글은 프로젝트를 업데이트하고 수정하는 데 도움이 될 뿐만 아니라 다른 사람들이 프로젝트를 받았을 때 귀하가 작성한 내용을 알 수 있도록 도와줍니다.

1. JavaScript 코드 주석 방법

JS 코드 주석은 한 줄 주석과 여러 줄 주석으로 구분됩니다.

1. 한 줄 주석

한 줄 주석은 //로 시작하고 // 뒤에 공백을 추가한 후 주석 내용을 작성합니다. 한 줄 주석은 현재 코드의 기능을 설명하는 데 사용할 수 있습니다. , 코드 등을 설명합니다.

코드 예: document.write("String is:"+str) 코드를 페이지에 표시할 필요 없이 한 줄로 주석 처리합니다.

<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 클래스 및 인터페이스에 주석을 추가할 때 주석은 클래스 앞과 using 또는 package 키워드 뒤에 배치되어야 합니다.

4. 클래스 속성인 public 및 protected 메서드를 만나면 클래스 속성인 public에 주석을 작성해야 합니다. 그리고 보호된 방법. // 주석만 사용하세요. 주석이 달린 코드를 정렬해야 합니다

5. 주석은 주석이 달린 코드 앞에 배치해야 하며, 별도의 줄로 작성하고 중간에 빈 줄을 두지 마십시오

6. 주석에 약어를 사용하려면 약어에 대한 필수 설명이 필요합니다

7. 멤버 변수에 대한 설명은 멤버 변수의 의미와 목적, 기능 및 사용처에 대해 //를 사용하여 설명합니다. 그리고 주석 달린 코드는 정렬되어야 합니다

요컨대, 모든 프로그래머는 주석을 작성하는 좋은 습관을 길러야 합니다. 이렇게 하면 코드를 더 쉽게 읽고 수정할 수 있을 뿐만 아니라 다른 사람들도 더 쉽게 이해하고 유지 관리할 수 있습니다. 당신의 코드.

위에서는 JS 코드의 주석 방법과 JS 코드의 주석 사양을 소개합니다. 더 많은 관련 튜토리얼을 보려면 JavaScript 비디오 튜토리얼

위 내용은 JS 코드 주석 방법 및 코드 주석 사양에 대한 심층적인 이해의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!