분류 javascript

JavaScript로 주석을 작성하는 방법 - JavaScript guide

컨텐츠 정보

  • 조회 261 (작성일 )

본문

목차​

  1. JavaScript 개발자 콘솔을 사용하는 방법
  2. HTML에 JavaScript를 추가하는 방법
  3. JavaScript에서 구문 및 코드 구조 이해
  4. JavaScript로 주석을 작성하는 방법
  5. JavaScript에서 데이터 유형 이해
  6. JavaScript에서 문자열로 작업하는 방법
  7. JavaScript에서 문자열을 인덱싱, 분할 및 조작하는 방법
  8. JavaScript에서 데이터 유형을 변환하는 방법
  9. JavaScript에서 변수, 범위 및 게양 이해
  10. 연산자를 사용하여 JavaScript에서 수학을 수행하는 방법
  11. JavaScript에서 배열 이해
  12. JavaScript에서 배열 메서드를 사용하는 방법 : Mutator 메서드
  13. JavaScript에서 배열 메서드를 사용하는 방법 : Accessor 메서드
  14. JavaScript에서 배열 메서드를 사용하는 방법 : Iteration 메서드
  15. JavaScript에서 객체 이해
  16. JavaScript에서 날짜 및 시간 이해
  17. JavaScript에서 이벤트 이해
  18. JavaScript에서 JSON으로 작업하는 방법
  19. JavaScript로 조건문을 작성하는 방법
  20. JavaScript에서 Switch 문을 사용하는 방법
  21. JavaScript에서 While 및 Do ... While 루프 사용
  22. JavaScript에서 For 루프를 생성하는 방법
  23. JavaScript에서 함수를 정의하는 방법
  24. JavaScript의 프로토 타입 및 상속 이해
  25. JavaScript에서 클래스 이해
  26. JavaScript에서 객체 메소드를 사용하는 방법
  27. JavaScript에서 This, Bind, Call 및 Apply 이해

JavaScript로 주석을 작성하는 방법 


소개 


프로그래밍에서 가장 먼저 고려해야 할 것은 컴퓨터입니다. 컴퓨터가 우리가 작성한 코드를 읽고 해석하는 방법입니다. 그러나 코드를 읽고 작업 할 사람들을 고려하는 것도 마찬가지로 중요합니다. 팀과 함께 또는 혼자서 작업하든, 독자를 위해 코드를 적절하게 설명하고 구성하는 방법을 배워야 합니다.


주석은 인터프리터가 무시하는 프로그램 소스 코드의 주석이므로 실제 코드 출력에는 영향을 미치지 않습니다. 주석은 코드가 무엇을 해야 하는지 의도를 설명하는 데 큰 도움이 될 수 있습니다.


개발자는 제대로 주석을 달지 않은 다른 사람이 작성한 코드를 조사하는 것이 실망스러울 수 있으며 더 이상 프로그램의 맥락에 몰두하지 않을 때 자신의 코드가 무엇을 의미했는지 잊어 버리기가 쉽습니다. 코드를 조기에 주석 처리하면 경력 전반에 걸쳐 좋은 프로그래밍 습관을 강화하여 나중에 이러한 문제를 피할 수 있습니다.


https://www.digitalocean.com/community/tutorials/how-to-write-comments-in-javascript 


주석 구문(Comment Syntax) 


서로 다른 두 가지 유형의 JavaScript 주석 구문을 간단히 살펴 보겠습니다.


한 줄 주석은 두 개의 슬래시 (//)로 작성됩니다.


// This is a comment

줄 끝까지 // 구문 바로 다음의 모든 문자는 JavaScript에서 무시됩니다.


다중 행 주석이라고도 하는 블록 주석은 여는 태그 (/ *)와 닫는 태그 (* /)로 작성됩니다. CSS를 알고 있다면 이미 블록 수준 주석에 익숙합니다.


/* This is
a comment */

위의 코드 블록에서 여는 태그와 닫는 태그 사이의 모든 내용은 무시됩니다.


이“Hello, World!”예제에서 설명 된 것처럼 한 줄 주석과 여러 줄 주석은 설명하도록 지정된 코드 위에 작성됩니다.


// Print "Hello, World!" to the console
console.log("Hello, World!");

주석을 작성할 때 주석 바로 아래의 코드와 동일한 레벨로 들여 쓰기 하십시오.


// Initialize a function
function alphabetizeOceans() {
    // Define oceans variable as a list of strings
    const oceans = ["Pacific", "Atlantic", "Indian", "Antarctic", "Arctic"];

    // Print alphabetized array to the console
    console.log(oceans.sort());
}

주석은 프로그램 자체와 마찬가지로 코드의 일부입니다. 오래된 주석은 주석이 없는 것보다 더 해로울 수 있으므로 정기적으로 주석을 유지 관리하고 업데이트 해야 합니다.


인라인 주석 


한 줄 주석은 코드 줄 끝에 나타날 때 인라인 주석이라고 합니다.


let x = 99;    // assign numerical value to x
let y = x + 2; // assign the sum of x + 2 to y

인라인 주석을 사용하여 작고 구체적인 컨텐츠 스니펫에 빠르게 주석을 달 수 있습니다. 주석은 작성된 정확한 행에만 관련되어야 하기 때문에 가장 명확한 주석 유형입니다.


한 줄에 한 줄 주석을 끝내는 방법은 없으므로 아래 예제와 같이 // 구문 뒤에 코드를 넣지 마십시오.

for (let i = 0; i === 10; i++) // for loop that runs ten times {
    // Running this code results in a syntax error
}

인라인 주석은 유용 할 수 있지만, 조금만 사용해야 합니다. 많은 인라인 주석으로 덮여있는 코드는 빠르게 지저분해져 읽기 어렵습니다.


블럭 주석


블록 수준 주석 또는 여러 줄 주석은 코드 섹션을 소개하고 설명하는 데 사용되는 긴 형식 주석입니다. 종종 이러한 유형의 주석은 파일의 맨 위에 또는 특히 복잡한 코드 블록 앞에 배치됩니다.


/* Initialize and invoke a the greetUser function
to assign user's name to a constant and print out
a greeting. */

function greetUser() {
    const name = prompt("What is your name?");
    console.log("Hello ," + name + "! How are you?");
}

greetUser();

/ **로 시작하고 주석 블록의 왼쪽에 별표가 포함 된 블록 주석 구문의 약간 수정 된 버전이 표시 될 수도 있습니다.


/**
 * Initialize constant with an array of strings.
 * Loop through each item in the array and print
 * it to the console.
 */

const seaCreatures = ["Shark", "Fish", "Octopus"];

for (const seaCreature of seaCreatures) {
  console.log(seaCreature);
}

때로는 이러한 유형의 주석에 스크립트 이름, 버전 및 작성자를 포함하여 프로그래밍 파일에 대한 세부 정보가 포함되기도 합니다.


JavaScript 초보자라면 작성하는 코드를 배우고 이해하는 데 필요한 만큼 쓸 수 있습니다. JavaScript 개발자로 진행하면서 방법 또는 방법과 반대로 의도 나 코드의 원인에 대한 답을 찾고자 합니다.


테스트를 위한 코드 주석 달기 


주석은 테스트 및 디버깅 목적으로 코드 실행을 빠르고 쉽게 방지하는 데 사용될 수 있습니다. 이것을 "코멘트 작성"이라고 합니다.


작성한 코드에 오류가 있는 경우 섹션을 주석 처리하면 해당 섹션이 실행되지 않으며 문제의 원인을 정확히 찾아내는 데 도움이 될 수 있습니다. 다른 결과를 테스트하기 위해 코드 간을 전환하는 데 사용할 수도 있습니다.


// Function to add two numbers
function addTwoNumbers(x, y) {
  let sum = x + y;
  return sum;
}

// Function to multiply two numbers
function multiplyTwoNumbers(x, y) {
  let product = x * y;
  return product;
}

/* In this example, we're commenting out the addTwoNumbers
function, therefore preventing it from executing. Only the
multiplyTwoNumbers function will run */

// addTwoNumbers(3, 5);
multiplyTwoNumbers(5, 9);

토글되는 섹션의 크기에 따라 한 줄 주석과 블록 주석을 모두 사용하여 코드를 주석 처리 할 수 ​​있습니다.


참고 : 코드 주석 처리는 테스트 중에만 수행해야 합니다. 주석 처리 된 코드 스니펫을 최종 스크립트에 두지 마십시오. 


프로그램의 논리를 연구 할 때, 코드를 주석 처리하면 버그의 위치를 ​​결정하거나 가장 유용한 유틸리티를 제공하는 코드를 평가할 때 도움이 될 수 있습니다.


결론 


자바 스크립트 코드는 컴퓨터에 의해 해석되지만, 앞으로 자기 자신을 포함하여 다른 프로그래머가 읽을 수 있습니다. 복잡한 코드 섹션에 적절한 주석을 남길 시간을 가지면 앞으로 배당금을 지불하게 되어 귀하와 공동 작업자가 작성한 코드의 의도를 보다 쉽게 ​​이해할 수 있습니다.