파이썬(Python) 주석 처리와 단축키 사용하는 방법

파이썬 주석 처리와 단축키 사용은 코드 가독성을 향상시키고 개발자의 생산성을 높이기 위해 중요합니다. 주석은 코드에 설명을 추가하고 다른 개발자들과 협업 시 이해를 돕는데 사용되며, 단축키는 코드 작성 속도를 높여 빠르게 개발할 수 있도록 도와줍니다. 주석 처리는 코드 문서화와 버그 추적에 도움을 주며, 단축키 사용은 반복적인 작업을 최소화하고 효율적인 코딩을 지원합니다. 따라서 주석과 단축키는 파이썬 코드의 가독성과 생산성을 향상시키는 핵심 요소로 사용됩니다. Java 나 C++, javascript 에서 사용하는 주석과 완전히 다릅니다.

 

 

 

▼ 그림처럼 주석은 크게 두 가지입니다. 여러 줄을 블록으로 설정해서 주석을 다는 방법과 한줄짜리 주석이 있습니다.

 

 

◎ 한줄 주석

 

 

▼ 한줄 주석은 “#” 을 사용합니다. 예제에서는 두 가지 형태가 가능합니다. 상단에 한줄을 쓰거나 프로그램 끝나는 맨 뒤에 놓을 수 있습니다. 뒤에 있는 것들은 모두 주석처리가 되므로 소스가 오면 안됩니다. 

# 더하기
data = 5 + 1
 
print(data) # 프린트

 

 

◎ 전체 주석

 

▼ 블록을 지정해서 전체를 주석으로 지정할 수 있는 방법은 쌍따움표/홑따움표 를 최소 3개씩 사용하는 것입니다. 시작과 끝에는 3개 이상을 입력해야 합니다. 참고로 자바나 C++ 은 /* */ 을 사용합니다.

 “””
 주석 처리에 대한 샘플
 여러 줄에 대한 주석을 처리하고 싶을 때 
“””

 

 

◎ 주석 단축키

 

 

▼ 주석은 자주 사용하는 기능이므로 단축키를 외워 두는 것이 좋습니다. 대표적인 파이썬 개발 툴인 PyDev 와 PyCharm 에서의 사용법은 다음과 같습니다.

 

- PyDev 인 경우

ctrl + 4 : 선택한 블록을 주석처리

ctrl + 5 : 선택한 블록의 주석을 해제

ctrl + # : 선택한 블록의 주석을 해제

 

- PyCharm 의 경우

ctrl + / : 주석처리와 해제 둘 다 가능합니다.

 

※ 아래는 참고하면 좋을 만한 글들의 링크를 모아둔 것입니다. ※ ▶ 파이썬 Python 개발을 위한 환경설정 – 명령 프롬프트로 개발하기 ▶ 파이썬(Python) 기본 개발툴 IDLE 설치하는 방법 ▶ 파이썬(Python) 문자열을 나눌 수 있는 split 함수 ▶ 파이썬 Python 기본이 되는 내장 데이터형, 자료형에 대해서 알아 보자 ▶ Python(파이썬) 주석 처리와 단축키 사용하는 방법

 

 

 

◎ 주석 처리 예외

 

 

▼ 함수안에 들어간 주석은 소스와 동일한 들여쓰기를 해야 합니다. 그렇지 않으면 expected an indented block 에러가 납니다.

 

 

▼ 그림처럼 소스와 함께 들여쓰기를 해 주면 에러를 해결할 수 있습니다. 

※ 아래는 참고하면 좋을 만한 글들의 링크를 모아둔 것입니다. ※ ▶ 파이썬 Python 개발을 위한 환경설정 – 명령 프롬프트로 개발하기 ▶ 파이썬(Python) 기본 개발툴 IDLE 설치하는 방법 ▶ 파이썬(Python) 문자열을 나눌 수 있는 split 함수 ▶ 파이썬 Python 기본이 되는 내장 데이터형, 자료형에 대해서 알아 보자 ▶ Python(파이썬) 주석 처리와 단축키 사용하는 방법