02. 주석
02-1. 주석이란?
주석(Commenting)이란 '코드를 작성하긴 했지만 브라우저에서 해당 코드를 실행시키지 말고 무시하라'는 뜻으로 쓰입니다.
index.js에서 회색으로 보이는 부분이 주석입니다.
02-2. 주석을 사용하는 이유
주석을 사용하는 이유는 여러가지가 있습니다.
- 특정 코드가 필요 없어졌는데, 혹시 몰라서 남겨놓고 싶을 때
- 다음 사람에게 인수인계 해야해서 코드에 설명해 놓을 때
- 코드를 볼 때마다 이해가 잘 안 돼서 한글로 설명해 놓을 때
- 등등..
개발자 중에 주석을 선호하는 사람도 있고 그렇지 않은 사람도 있습니다. 각자의 이유는 많습니다.
🙆♂ 주석을 좋아하는 개발자 :
- 시간이 지나 이 코드를 유지보수 할 때를 대비해서
- 협업 시 의사소통을 위해서
- ...
🙅♂️ 주석을 싫어하는 개발자 :
- 주석을 많이 작성하면 코드가 지저분해져서
- 주석이 필요하다는 건 코드를 제대로 짜지 않았다는 뜻이라 생각해서 (코드를 제대로 짰다면 주석이 필요 없을 정도로 가독성이 좋을 것이다)
다만 개발 초보자의 경우, 좋은 예제의 코드를 분석하면서 주석을 달고 코드를 이해하며 공부하는 것은 좋은 방법이라고 생각합니다.
02-3. 주석의 형태
주석의 형태는 다양합니다.
// 이 줄은 주석이고, 브라우저에서 무시하게 됩니다.
for (var i = 0; i < 5; i++) {
if (animals[i] === "bat") {
animals[i] = "cat";
}
}
let animals = []; // 빈 열 선언하기
//animals.push(1); 일단 나중에 처리하자.
// 주석달 때는 slash 두개로 시작합니다. slash 두 개(//)로 시작한 줄은 주석입니다.
그렇다면 다음 코드는 어떨까요?
// 일단 변수 선언하고 ... (1)
그 다음에 값 할당 ... (2)
let name;
name = "예리";slash 두 개로 시작한 한 줄(1)만 주석을 인식하기 때문에 두 번째 줄(2)은 에러가 납니다.
여러 줄을 한 번에 주석처리하고 싶으면 아래와 같이 /* 로 시작해서 */ 로 끝냅니다.
/* 두 줄 이상 주석 처리하려면,
이런식으로..!!
시작과 끝을..
잘 막아주세요 */
//아니면
//이렇게
//한 줄 한 줄 처리합니다코드 중간중간 주석 처리도 가능합니다.
// 함수 이름 뭐로 하지? 일단 calculateTotal로 해야겠다.
function calculateTotal(price) {
// function getTotal(price) { 👈👈👈 여기!
return price * 1.1;
}주석을 싫어하는 개발자, 주석을 자주 사용하는 개발자가 있듯이 이처럼 주석을 사용하는 것은 굉장히 주관적 입니다. 코드는 작성되는 경우보다 남들에게 읽히는 경우가 훨씬 많습니다. 주석도, 앞으로 배우는 변수명, 함수명을 작성하는 작성하는 것도 결국에는 "소통" 을 위해 개발자들이 신경써야 하는 것들 중 하나 입니다. 주석을 적절하게 활용하여 코드를 통해 더 나은 "소통" 을 이루시는 여러분들이 되시길 바랍니다 :)
Assignment
index.js에 있는 ignore() 함수가 실행될 수 있도록 주석을 풀어주세요.
// 위의 run을 눌러보세요!
console.log(10/2) // 아래 콘솔 창에 () 소괄호 내부에 있는 결과 값 출력하기
// 주석달 때는 slash 두개로 시작합니다.
let name = "김";
console.log("hi" + name);
// 다양한 방법으로!
console.log("========================", "**************")
// 여러 줄 작성할 때는 이렇게..
function ignore() {
return true;
}
ignore();
// 아래의 코드는 절대로 수정하거나 삭제하지 마세요.
module.exports = {ignore};
