06 주석과 코드 정리

코드를 작성할 때 주석(Comments)을 사용하는 것은 코드의 가독성을 높이고, 유지보수를 용이하게 만드는 핵심 도구입니다. 주석은 프로그램에 영향을 미치지 않는 설명이나 메모로, 코드의 의미나 목적을 쉽게 이해할 수 있도록 돕습니다.

오토핫키 v2에서는 단일 라인 주석과 다중 라인 주석을 모두 지원합니다. 또한, 코드 정리 방법을 통해 가독성 높은 코드를 작성할 수 있습니다.

1. 주석(Comment)

오토핫키 v2의 주석(Comment)은 코드에 대한 설명, 메모 또는 참고 정보를 제공합니다. 주석은 프로그램에 영향을 미치지 않으며, 실행되지 않는 코드입니다.

주석의 주요 목적은 다음과 같습니다.

• 코드의 가독성 향상: 코드의 목적과 동작을 설명합니다.
• 코드의 유지보수 용이성: 다른 사람이나 미래의 자신이 코드를 쉽게 이해할 수 있도록 합니다.
• 디버깅 지원: 코드의 일부분을 주석으로 변경하여 실행을 건너뛰는 방식으로 오류를 찾을 수 있습니다.

1.1 단일 라인 주석 (Single-Line Comment)

단일 라인 주석은 한 줄 전체를 주석 처리할 때 사용합니다. 오토핫키 v2에서는 ;(세미콜론) 기호를 사용하여 단일 라인 주석을 작성합니다.

사용 방법

; 이 코드는 단일 라인 주석입니다.
MsgBox("이 메시지는 출력됩니다.") ; 이 부분도 주석입니다.

예제 1: 단일 라인 주석 사용

; 프로그램 시작
MsgBox("Hello, World!") ; 여기는 Hello 메시지를 출력하는 코드입니다.

설명

• ; 프로그램 시작: 주석으로만 사용되며 실행되지 않습니다.
• MsgBox("Hello, World!"): 코드의 끝에 ; 주석이 작성되었지만,
  주석 이후의 내용은 프로그램에 영향을 주지 않습니다.

예제 2: 코드 중단을 위해 단일 라인 주석 사용

; MsgBox("이 코드는 실행되지 않습니다.")
MsgBox("이 코드는 실행됩니다.")

설명

• MsgBox("이 코드는 실행되지 않습니다.")는 ; 주석으로 비활성화되었습니다.
• MsgBox("이 코드는 실행됩니다.")는 정상적으로 실행됩니다.

1.2 다중 라인 주석 (Multi-Line Comment)

다중 라인 주석은 여러 줄의 코드를 한꺼번에 주석 처리할 때 사용합니다. 오토핫키 v2에서는 / 와 / 사이에 위치한 모든 코드가 주석으로 처리됩니다.

사용 방법

/*
이 부분은 모두 주석 처리됩니다.
여러 줄의 설명을 추가할 수 있습니다.
이 코드는 실행되지 않습니다.
*/

예제 1: 다중 라인 주석 사용

/*
여러 줄의 주석 예시
이 프로그램은 사용자에게 메시지를 출력합니다.
단일 라인 주석보다 여러 줄의 메모가 필요할 때 사용합니다.
*/
MsgBox("Hello, World!")

설명

• / 와 / 사이의 모든 줄이 주석으로 인식되어 실행되지 않습니다.
• MsgBox("Hello, World!")는 주석 바깥에 있으므로 정상적으로 실행됩니다.

예제 2: 코드의 일부를 비활성화하는 다중 라인 주석

/*
MsgBox("이 코드는 실행되지 않습니다.")
MsgBox("이 코드는 실행되지 않습니다.")
*/
MsgBox("이 코드는 실행됩니다.")

설명

• / 와 / 사이의 코드는 주석으로 처리되어 실행되지 않습니다.
• MsgBox("이 코드는 실행됩니다.")는 정상적으로 실행됩니다.

Tip: 디버깅 중에 일부 코드를 임시로 비활성화할 때 유용합니다.

2. 코드 정리 방법

코드 정리는 가독성을 높이고 코드의 유지보수를 쉽게 하기 위한 작업입니다. 잘 정리된 코드는 오류를 줄이고 협업을 원활하게 진행할 수 있습니다.

2.1 코드 들여쓰기 (Indentation)

• 코드 블록(중괄호 ) 내부는 들여쓰기(Tab 또는 4개의 공백)를 사용합니다.
• 들여쓰기를 통해 코드의 계층 구조와 논리 관계를 명확히 할 수 있습니다.

예제

MyFunction() {
    if (true) {
        MsgBox("조건이 참일 때 실행됩니다.")
    } else {
        MsgBox("조건이 거짓일 때 실행됩니다.")
    }
}

2.2 빈 줄 추가하기

• 서로 다른 기능을 수행하는 코드 블록 사이에는 빈 줄을 추가하여 구분합니다.
• 빈 줄을 통해 코드의 논리적 흐름을 명확히 할 수 있습니다.

예제

; 프로그램 시작
MsgBox("프로그램 시작")

; 사용자 입력 받기
input := InputBox("이름을 입력하세요.")

; 입력값 확인
MsgBox("입력한 이름: " input)

2.3 코드의 길이 제한

• 한 줄에 너무 많은 코드를 작성하지 않도록 합니다.
• 긴 코드는 여러 줄로 나누어 작성하여 가독성을 높입니다.

예제

; 긴 코드 (나쁜 예시)
MsgBox("이 코드는 너무 길고, 코드가 어디서 끝나는지 파악하기 어렵습니다. 개선이 필요합니다.")

; 개선된 코드 (좋은 예시)
MsgBox(
    "이 코드는 적절한 줄바꿈을 사용하여 "
    "코드의 흐름을 쉽게 파악할 수 있습니다."
)

2.4 의미 있는 변수명 사용하기

• 의미 있는 변수명을 사용하여 코드의 의도를 명확히 합니다.
• 예를 들어, x, y 대신 userName, itemCount 같은 명확한 이름을 사용합니다.

예제

; 나쁜 예시
x := 10
y := x * 2
MsgBox(y)

; 좋은 예시
userAge := 10
doubleAge := userAge * 2
MsgBox("두 배 나이: " doubleAge)

2.5 주석을 통해 코드의 의미 설명하기

• 코드의 의도를 설명하는 주석을 추가하여 왜 이 코드가 필요한지 기록합니다.
• 주석은 의미를 설명하는 것이 목적이므로, 동작을 설명하지는 않습니다.

예제

; 사용자가 입력한 이름을 확인합니다.
userName := InputBox("이름을 입력하세요.")

; 입력된 이름이 비어 있는 경우, 오류 메시지를 출력합니다.
if (userName = "") {
    MsgBox("이름을 입력해야 합니다.")
}

Tip: "무엇을 하는지"보다는 "왜 필요한지"를 설명하는 주석을 작성하세요.

정리

1. 단일 라인 주석: ; (세미콜론)으로 시작하며, 줄 끝까지 주석으로 처리합니다.
2. 다중 라인 주석: /와 / 사이의 모든 코드가 주석으로 처리됩니다.
3. 코드 정리 방법
   • 들여쓰기: 코드 블록은 Tab 또는 4개의 공백으로 들여쓰기 합니다.
   • 빈 줄 추가: 서로 다른 기능 사이에 빈 줄을 추가합니다.
   • 의미 있는 변수명 사용: userName, itemCount 같은 명확한 이름을 사용합니다.
   • 주석 추가: 코드의 의미나 목적을 명확히 하는 주석을 추가합니다.