코드 주석(Commenting Code)
코드를 작성하는 것은 컴퓨터에게 특정 작업을 수행하도록 지시하는 흥미로운 과정입니다. 하지만 코드는 단순히 컴퓨터만을 위한 것이 아니라, 다른 사람들도 읽을 수 있어야 합니다. 따라서 우리의 의도를 명확하게 전달하는 것이 중요합니다.
다행히도 우리는 코드의 기능을 수행하는 문법뿐만 아니라 주석(comments) 을 작성할 수 있습니다. 주석은 코드의 독자(사람)를 위한 메모이며, 실행되지 않기 때문에 유효한 문법이 필요하지 않습니다.
1. 단일 행 주석 (Single-line Comment)
짧은 주석을 작성할 때는 단일 행 주석을 사용합니다.
단일 행 주석은 // 기호로 시작하며, 같은 줄의 // 이후 모든 내용이 주석으로 처리됩니다.
// 고객 만족도 점수를 계산하는 코드
int satisfactionScore = 95;2. 여러 줄 주석 (Multi-line Comment)
긴 주석을 작성할 때는 여러 줄 주석을 사용합니다.
여러 줄 주석은 /* 로 시작하고 */ 로 끝나며, 그 사이의 모든 내용이 주석으로 처리됩니다.
/*
우리는 데이터 손실 가능성을 최소화하기 위해
정보를 여러 개의 데이터베이스에 저장하기로 결정했습니다.
그러나 동기화 문제가 발생하지 않도록 주의해야 합니다!
*/3. 자바독(Javadoc) 주석
Javadoc 주석은 /** 로 시작하고 */ 로 끝나는 특별한 형식의 주석으로,
API(Application Programming Interface) 문서를 생성할 때 사용됩니다.
Javadoc 주석은 주로 클래스, 메서드, 필드 선언 전에 작성되며,
API 사용자들이 읽을 공식 문서로 변환될 수 있으므로 신중하게 작성하는 것이 중요합니다.
/**
* 이 클래스는 주석이 코드 내에서 어떻게 사용되는지를 보여줍니다.
*/
public class CommentExample {
// 클래스 내부에서 사용된 단일 행 주석
public static void main(String[] args) {
// 메서드 내부에서 사용된 단일 행 주석
System.out.println("이 프로그램에는 주석이 포함되어 있습니다!");
}
}4. 주석과 출력의 차이점
주석은 코드에 대한 설명을 제공하지만, 실행되지 않습니다.
반면, System.out.println() 같은 출력문을 사용하면 텍스트가 터미널에 출력됩니다.
예를 들어:
// 이 코드는 출력되지 않습니다.
System.out.println("이 문장은 터미널에 표시됩니다!"); // 이 코드는 실행됩니다.주석은 코드의 가독성을 높이고, 코드의 의도를 명확히 전달하는 데 중요한 역할을 합니다.
적절한 주석 사용을 습관화하면 더 좋은 개발자가 될 수 있습니다! 🚀
