JavaScript에서 주석을 작성하는 방법
소개
프로그래밍에서 우리의 첫 번째 고려 사항은 일반적으로 컴퓨터, 즉 컴퓨터가 우리가 작성한 코드를 읽고 해석하는 방법입니다. 그러나 코드를 읽고 작업할 사람들을 고려하는 것도 똑같이 중요합니다. 팀과 함께 작업하든 혼자 작업하든 인간 독자를 위해 코드를 적절하게 설명하고 구조화하는 방법을 배워야 합니다.
주석은 인터프리터가 무시하는 프로그램 소스 코드의 주석이므로 코드의 실제 출력에 영향을 미치지 않습니다. 주석은 코드가 수행하거나 수행해야 하는 작업의 의도를 설명하는 데 큰 도움이 될 수 있습니다.
개발자로서 적절하게 주석 처리되지 않은 다른 사람이 작성한 코드를 파헤치는 것은 실망스러울 수 있으며 더 이상 프로그램 컨텍스트에 몰입하지 않을 때 자신의 코드가 의미하는 바를 잊기 쉽습니다. 초기에 코드에 주석을 다는 것은 나중에 이러한 문제를 피하기 위해 경력 전반에 걸쳐 좋은 프로그래밍 습관을 강화할 것입니다.
주석 구문
두 가지 유형의 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);
한 줄 주석과 블록 주석 모두 토글되는 섹션의 크기에 따라 코드를 주석 처리하는 데 사용할 수 있습니다.
참고: 코드 주석 처리는 테스트 목적으로만 수행해야 합니다. 최종 스크립트에 주석 처리된 코드 스니펫을 남기지 마십시오.
프로그램의 논리를 실행할 때 코드를 주석 처리하면 버그가 있는 위치를 확인하거나 가장 유용한 코드 줄을 평가할 때 도움이 될 수 있습니다.
결론
JavaScript 코드는 컴퓨터에 의해 해석되지만 항상 미래의 자신을 포함한 다른 프로그래머가 읽습니다. 코드의 복잡한 섹션에 적절한 주석을 남기는 데 시간을 투자하면 나중에 배당금을 지급하여 귀하와 공동 작업자가 작성한 코드의 의도를 더 쉽게 이해할 수 있습니다.