본문 바로가기

Java

[Java] 01.03 - 들여쓰기와 주석

들어가며

 본인은 여름이 싫다.

 여름의 3대 죄악.

 모기, 습기, 열기.

 그래서 인간이 반성해야 한다.

 근데 모기는 예외다.

 제발 멸종했으면 좋겠다.

 

블록 단위 주석

 다음 내용을 소스파일 앞 부분에
기록해 둔다고 가정하자.

파일 이름: Practice.java
작성자: 심플심플심플심플
작성일: 2020년 7월 17일
목적: System.out.println 메소드의 기능 테스트

 이렇듯 주석으로 처리해야 할 내용이
여러 줄에 걸쳐서 존재하는 경우,

 생각해 볼 수 있는 것이 '블록 단위
주석'이다.

 이는 주석의 시작을 '/*'으로, 그리고
끝을 '*/'으로 표시한다.

 그러면 그 사이의 모든 내용은 주석으로
인식된다.

 그럼 위의 내용을 주석으로 넣으면
다음과 같다.

/*
파일 이름: Practice.java
작성자: 심플심플심플심플
작성일: 2020년 7월 17일
목적: System.out.println 메소드의 기능 테스트
*/

public class class_name {
    public static void main(String[] args){
    
        /*다음은 단순한 정수의 출력*/
        System.out.println(7);
        
        System.out.println(3.14);
        System.out.println("3 + 5 = " + 8);
        System.out.println(3.14 + "는 실수 입니다.");
        System.out.println("3 + 5" + "의 연산 결과는 8입니다.");
        
        /*다음은 덧셈 결과의 출력*/
        System.out.println(3 + 5);
    }
}

 위의 소스파일을 컴파일 및 실행을
해보면,

 주석은 프로그램에 아무런 영향을
미치지 않음을 알 수 있다.

 그리고 파일의 앞부분에 등장하는
소스파일에 대한

 기록 및 전체적인 개요에 해당하는
주석은

 다음과 같이 처리하는 경우도 있다.

 즉, 주석 사이에 '*'을 넣을 수도 있다.

/*
 * 파일 이름: Practice.java
 * 작성자: 심플심플심플심플
 * 작성일: 2020년 7월 17일
 * 목적: System.out.println 메소드의 기능 테스트
 */

public class class_name {
    public static void main(String[] args){
        ......
    }
}

 그러나 블록 단위 주석 사이에는
'/*' 또는 '*/'이 등장해선 안 된다.

 이것이 있을 경우, 주석의 경계
구분에 문제가 생긴다.

 하지만 그 이외의 무엇이든
넣을 수 있다.

 

행 단위 주석

 주석 처리해야 할 문장이 하나
혹은 둘이라면,

 다음의 예제에서 보이듯이 '행
단위 주석 처리'가 적절하다.

// 파일 이름: Practice.java
// 작성자: 심플심플심플심플
// 작성일: 2020년 7월 17일
// 목적: System.out.println 메소드의 기능 테스트

public class class_name {
    public static void main(String[] args){
        ......
    }
}

 결과적으로 앞서 보인 소스코드는
모두 동일한 프로그램이다.

 주석의 유무와 주석의 처리 방식에만
차이가 있을 뿐이다.

 

들여쓰기

 영역 또는 의미의 구분을 위해서
일정 간격으로

 왼쪽에서 띄운 후에 문장을 입력하는
것을 가리켜 '들여쓰기' 라고 한다.

public class class_name {
    // 4칸 정도 들여쓰기
    public static void main(String[] args){
        // 4칸 정도 들여쓰기
        System.out.println("...");
    }
}

 통합 개발 환경(IDLE)은 들여쓰기를
자동으로 진행해준다.

 하지만 메모장과 같은 단순한
편집기를 이용하면

 직접 들여쓰기를 해야 한다.

 

중괄호를 열고 닫는 스타일

 중괄호에 관해 프로그래머들의
코딩 스타일은

 다음과 같은 2가지 종류가 있다.

public class class_name
{
    public static void main(String[] args)
    {
        System.out.println("...");
    }
}
public class class_name {
    public static void main(String[] args) {
        System.out.println("...");
    }
}

 후자의 경우는 코드에 대한 더 좋은
시야를 제공하기 때문에,

 많은 프로그래머들과 서적에서
권고하는 방식이다.

 어디까지나 취향과 스타일의
차이이므로,

 어느쪽을 선택하든지, 사용자의
선택에 달려있다.


참고 및 출처

윤성우의 열혈 Java 프로그래밍
국내도서
저자 : 윤성우
출판 : 오렌지미디어 2017.07.05
상세보기