3장: 주석, #

1. 주석 개요

TCL에서 주석은 코드의 가독성을 높이고 설명을 추가하는 데 사용됩니다. 주석은 실행되지 않는 텍스트입니다.

2. # 주석

2.1 기본 사용법

# 이것은 한 줄 주석입니다
set x 10  ;# 이것도 주석입니다. ;는 줄바꿈입니다.

2.2 특징

  • 줄의 시작 부분에서 사용하면 해당 줄 전체가 주석 처리됨

  • 명령 뒤에 사용하면 해당 지점부터 줄 끝까지 주석 처리됨

2.3 주의사항 ⚠️

  • 문자열 내부의 #는 주석으로 처리되지 않음

    puts "This # is not a comment"

3. 여러 줄 주석

TCL은 공식적인 여러 줄 주석 문법이 없지만, 다음과 같은 방법을 사용할 수 있습니다:

4.1 if 0 사용

if 0 {
    이 부분은 실행되지 않습니다
    여러 줄의 코드나 텍스트를 주석 처리할 수 있습니다
}

4.2 여러 # 사용

# 첫 번째 줄 주석
# 두 번째 줄 주석
# 세 번째 줄 주석

5. 주석 활용 팁 💡

  • 코드의 목적과 기능 설명에 사용

  • 복잡한 알고리즘이나 로직 설명에 활용

  • 임시로 코드 비활성화할 때 사용

  • 버전 정보나 작성자 정보 기록에 활용

  • 주석 사용법에 대해, Clean code 등 다양한 책과 강의가 있습니다. 대기업에는 코딩 스타일 규칙이 있습니다.

  • 간결하고 명확하게 작성

  • 코드 자체로 설명이 되는 경우 불필요한 주석 지양

  • 주기적으로 주석 업데이트하여 코드와 일치하도록 유지

  • 중요한 결정사항이나 차후 개선점 등을 기록하는 데 활용

Last updated