- 주석이란
- 주석을 사용하는 이유
- 주석 / 실행문
- 보기 좋은 코딩?
1. 주석이란
주석(comment) 이란 프로그램 내에서 실행되지 않는 영역을 표시 하기 위해 사용합니다.
주석의 종류는 한줄 주석과, 여러줄 주석, 자바독(javadoc) 주석이 있으며, 소스 코드에 대한 설명을 작성해 두거나, 프로그램 실행이 되지 않는 영역으로 표시하기 위해 주석을 사용합니다.
| 기호 | 설명 |
| // 한줄 코드 | // 부터 해당 라인(줄) 끝까지 주석 |
| /* 여러줄 코드 */ | /* 와 */ 사이의 모든 코드를 주석 |
| /** 여러줄 코드 */ | Java Document 주석 |
2. 주석을 사용하는 이유
주석을 사용하는 이유는 크게 3가지로 나눌 수 있습니다.
첫째, 프로그램 코드 상에서 해당 영역의 실행 코드가 실행되지 않게 하기 위해.
둘째, 내가 작성한 코드를 다른 사람이 볼 때 쉽게 이해하기 위해 설명 구문을 주석으로 작성.
셋째, 나중에 내가 다시 이 코드를 봤을 때 왜 이렇게 코딩 했는지 메모.
실제로 내가 작성한 코드면 나중에 다시 내가 보면 금방 이해할 수 있을거라 생각하지만, 그렇지 않습니다. 몇일만 지나도, '내가 왜 이렇게 코딩했더라?' 기억이 잘 나지 않는 경우가 생각보다 많습니다.
3. 주석 / 실행문
앞에서 작성했던 Test 파일을 아래처럼 수정해보겠습니다.
public class Test {
public static void main(String[] args) {
// System.out.println("Hello");
/*
* Hello를 출력하는 실행문을 주석처리 하고
* 아래 안녕 자바라고 출력되는 실행문을 추가
*/
// "안녕 자바"라고 출력되는 실행문
System.out.println("안녕 자바");
}
}
main 이라는 메서드가 자바 프로그램을 실행하는 시작점이라고 했죠?
프로그램을 실행(Ctrl+F11) 하면 main 메서드 안의 코드들이 실행되게 되는데, 위에 코드 중 회색부분은 프로그램 실행에 전혀 영향을 주지 않는 주석에 해당하는 코드들입니다. 다시 말하면 이 코드들은 없어도 실행결과는 동일하다는 이야기입니다.
먼저 첫번째 // System.out.println("Hello"); 를 보면 앞에서 콘솔에 Hello 라고 출력했던 코드인데, 앞쪽에 // (슬러시 두개)가 들어가면서 글자색도 회색으로 바뀌고, 실행시 Hello가 출력되지 않는것을 알 수 있습니다. (여기 블로그에서는 주석이 회색으로 나오지만 이클립스에서는 초록색으로 나옵니다)
다음 아래에는 /*와 */ 사이에 Hello를 출력하는 부터 아래줄 아래 안녕 자바라고... 까지 총 4줄이 회색으로 여러줄이 주석 처리 되어있습니다. 한줄 주석과 용도는 동일하지만 주석 안쪽에서 엔터를 치면 자동으로 주석 라인이 추가되게 됩니다.
마지막 세번째는 System.out.println("안녕 자바"); 실행코드 위에 // "안녕 자바"라고 출력되는 실행문이라고 한 줄 주석이 있습니다. 이런 형태의 주석은 보통 바로 아래 실행코드를 설명해주는 형태의 주석으로 사용됩니다.
실행문은 프로그램에서 처리하는 하나의 단위를 의미합니다. 그래서 하나의 실행단위가 끝났다라는 것을 표현하기 위에 뒤에 ;(세미콜론)을 찍습니다.
앞에서 작성했던 Hello 파일에서 “Hello”를 화면에 출력하는 실행문은 System.out.println() 처럼 보통 한 줄씩 작성하며 해당 실행문의 마지막에는 반드시 ;를 붙여 실행문이 끝났음을 표현해주어야 합니다. 마지막에 세미콜론을 붙이지 않으면 에러가 발생하게 됩니다.
한 줄에 하나의 실행문일 수도 있지만, 한 줄에 여러 실행문이 될 수도 있습니다. 예를들어 위 코드를 아래와 같이 바꿀 수도 있습니다.
System.out.println("Hello");System.out.println("안녕 자바");
;(세미콜론)은 실행문이 끝났다라는 뜻이기 때문에 ;를 기준으로 줄바꿈해서 다음줄에 적어도 실행결과는 완전히 동일합니다. 즉 한줄로 쓰나 두줄로 쓰나 실행결과는 완전히 동일하게 실행됩니다. 하지만 소스코드는 실행결과만을 위한 것이 아니라 나중에 다시 보고 수정해야 하는 경우도 있기 때문에 여러 실행문을 한줄로 쓰게 되면 코드가 길어지는 경우 가독성이 떨어져 여러줄로 쓰는 것이 가독성이 높아집니다.
4. 보기 좋은 코딩?
지금까지 자바와 이클립스를 설치하고, 간단한 출력을 위한 프로그래밍을 실행해보았습니다. 그리고 코드 작성 시 설명 문구를 넣기 위해 주석을 사용하고, 실행문을 구분하는 ;(세미콜론)에 대해서 배웠는데, 앞으로 배울 다양한 문법들이 있을텐데, 그 전에 반드시 알아두어야 하는 부분이 있습니다. 코드는 나혼자 보기 위한게 아니라 여러 사람이 같이 보는 코드라는 사실입니다. 프로그램 개발 역시 혼자서 개발하는 경우보다 여러 사람이 같이 개발하는 경우가 훨씬 많기 때문에, 누가 봐도 알기 쉽게 보기 좋게 코딩하는게 중요합니다. 이 부분을 본격적인 학습전에 소개하는 이유는 처음 프로그래밍을 배울 때부터 반드시 습관을 들여야 하기 때문입니다. 우리가 처음 언어를 배우고 글쓰기를 배울 때 맞춤법, 띄어쓰기를 많이 연습합니다. 이클립스 같은 개발도구에서 맞춤법이 틀리면 바로 알려주지만, 위에서 배웠던 주석을 이용한 코드 설명, 띄어쓰기를 이용한 줄맞춤, 줄바꿈을 이용한 실행문 구조를 잘 맞춰서 코딩하는 습관을 들여야 나중에 복잡한 프로그램을 만들 때 보기좋은 코딩을 할 수 있게 됩니다.
“세살 버릇 여든까지 간다”라는 속담이 있습니다. 지금부터 여러분 손이 익힐 수 있도록 반복적으로 많이 연습하고, 습관을 들이시면 보기 좋은 코딩을 할 수 있습니다.