02. 주석
02-1. 주석이란?
주석(Commenting)이란 '프로그래밍에 있어 부연 설명 등과 같이 코드 외적으로 파악해야 할 내용을 메모하는 것'을 의미합니다.
소스 코드를 더 쉽게 이해할 수 있게 만드는 것이 주 목적이고 다른 개발자들과의 협업에서 유용하게 쓰입니다. 주석처리 된 코드는 프로그램 실행 시 영향을 주지 않기 때문에, 디버깅 시에도 개발자 본인만 알아볼 수 있는 표식으로도 자주 활용합니다.
//주석이란 래퍼가 있었던거 같은데..02-2. 주석을 사용하는 이유
주석을 사용하는 이유는 여러가지가 있습니다. 그 중 몇 가지를 예시로 들면 다음과 같습니다.
- 특정 코드가 필요 없어졌는데, 혹시 몰라서 남겨놓고 싶을 때
- 다음 사람에게 인수인계 해야해서 코드에 설명해 놓을 때
- 코드를 볼 때마다 이해가 잘 안 돼서 별도의 설명을 적어 놓을 때
개발자 중 주석을 선호하는 사람이 있는 반면에 그렇지 않은 사람도 있습니다. 주석에 대한 선호도가 갈리는 이유는 여러가지가 있습니다.
🙆🏻♀️ 주석을 좋아하는 개발자 :
-
시간이 지나 이 코드를 유지보수 할 때 유리하다.
-
협업 시 다른 개발자와의 원활한 소통이 가능하다.
🙅🏻♀️ 주석을 싫어하는 개발자 : -
주석을 많이 작성하면 코드가 지저분해진다.
-
주석이 필요하다는 건 코드를 제대로 짜지 않았다는 뜻이다. 만일 코드를 올바르게 작성하였다면 주석이 필요 없을 정도로 가독성이 좋을 것이다.
다만 실무 환경에 놓인 개발자가 아닌, 개인적인 학습 목적으로 코드를 작성하는 개발 초보자의 경우에, 좋은 예제의 코드를 분석하면서 주석을 달며 공부하는 것은 좋은 방법이라고 생각합니다.
주석을 싫어하는 개발자, 주석을 자주 사용하는 개발자가 있듯이 이처럼 주석을 사용하는 것은 굉장히 주관적으로 해석됩니다. 코드는 작성되는 경우보다 남들에게 읽히는 경우가 훨씬 많습니다. 주석을 어느 시점에 어떻게 사용하냐는 결국에 올바른 "소통" 을 위해 개발자들이 세심하게 살펴야 하는 요소입니다. 주석을 적절하게 활용하여 코드를 통해 효과적인 "소통" 을 경험하고 체득하시길 바랍니다.
02-3. 주석의 형태
주석의 형태는 다양합니다.
// 이 줄은 주석이고, 자바스크립트 로직 상에 영향을 주지 않습니다.
for (let i = 0; i < 5; i++) {
if (animals[i] === "bat") {
animals[i] = "cat";
}
}
const animals = []; // 빈 배열 선언하기
// animals.push(1); // 나중에 처리하기
// 주석을 다는 문법은 slash 두 개를 이어 붙여 코드를 시작하는 것 입니다.slash 두 개(//)로 시작한 줄은 주석을 의미합니다.
그렇다면 다음의 코드는 어떨까요?
// 변수 선언하고 ... (1)
그 다음에 값 할당 ... (2)
let name;
name = "wecode";slash 두 개로 시작한 한 줄(1)만 주석을 인식하기 때문에 두 번째 줄(2)은 에러가 납니다.
여러 줄을 한 번에 주석처리하고 싶으면 아래와 같이 / 로 시작해서 / 로 끝냅니다.
/* 두 줄 이상 주석 처리하려면,
이런식으로
시작과 끝을
잘 막아주세요! */
// 아니면
// 이렇게
// 한 줄 한 줄 일일이 써주셔야 합니다.코드 중간중간에서도 주석 처리가 가능합니다.
// 함수 이름 뭐로 하지? 일단 calculateTotal로 해야겠다.
function calculateTotal(price) {
// function getTotal(price) { 👈👈👈 여기!
return price * 1.1;
}추가로 Windows에서는 ctrl + /, macOS에서는 cmd + / 단축키를 통해 커서가 위치한 줄의 코드를 주석 처리할 수 있습니다.
출처 : wecode
