15개 프로그래밍 언어로 주석을 추가하는 예

프로그래밍에서 주석이 무엇인지, 그리고 왜 중요한지 심층적으로 알아보겠습니다.

또한, 일반적으로 사용되는 두 가지 주석 유형과, 15가지 프로그래밍 언어에서 이를 작성하는 구체적인 방법을 상세히 살펴봅니다.

프로그래밍 주석이란 무엇일까요?

일반적인 용어로 주석은 최종 사용자에게는 보이지 않고, 코드를 작성하는 개발자들을 위한 일종의 메모입니다. 코드에 대한 설명을 첨부하여 이해를 돕는 역할을 합니다.

좀 더 기술적으로 설명하자면, 주석은 프로그램이 어떻게 작동하는지에 대한 설명을 사람이 읽기 쉬운 형태로 제공하는 것입니다. 일반적으로 코드의 특정 부분을 명확하게 설명해야 할 때 사용됩니다. 주석은 코드의 가독성을 높이고, 지식 전달에 필요한 시간과 노력을 줄여줍니다.

컴파일러나 인터프리터는 코드 내 주석을 무시하기 때문에 프로그램의 최종 결과에는 영향을 미치지 않습니다. 간단히 말해, 주석은 특정 코드 조각에 대한 간결하고 이해하기 쉬운 설명이라고 할 수 있습니다.

일반적인 주석 유형

대부분의 프로그래밍 언어는 다음 두 가지 주석 유형을 지원합니다.

• 한 줄 주석
• 여러 줄 주석 (블록 주석)

이름에서 알 수 있듯이, 한 줄 주석은 짧은 한 줄 텍스트를 추가해야 할 때 편리합니다. 예를 들어, 특정 조건이나 상수의 간단한 설명이 필요한 경우에 유용합니다. 반면, 여러 줄 주석은 함수에 대한 상세 설명이나 사용법 등과 같이 더 많은 정보를 추가해야 할 때 적합합니다.

이 외에도 문서화 주석과 같은 다른 유형의 주석도 있지만, 본 글에서는 다루지 않습니다.

왜 주석을 추가해야 할까요?

“어떤 바보라도 컴퓨터가 이해할 수 있는 코드를 작성할 수 있습니다. 훌륭한 프로그래머는 사람이 이해할 수 있는 코드를 작성합니다.” – 마틴 파울러

주석 추가의 가장 큰 장점은 코드 가독성을 높이고 프로그램에 대한 이해도를 향상시킨다는 점입니다. 이 외에도 다음과 같은 추가적인 이점이 있습니다.

• 주석을 통해 동료 개발자들이 코드를 더 쉽게 이해할 수 있으며, 긴 문서를 읽어야 하는 부담을 줄일 수 있습니다.
• 개발자 간의 불필요한 의사소통을 줄여줍니다.
• 컴파일러나 인터프리터에서 주석은 무시됩니다.
• 오픈 소스 소프트웨어의 경우, 수많은 개발자에게 코드의 모든 기능을 설명하는 것이 불가능하기 때문에 주석은 필수적입니다.

다양한 언어에서의 주석

이제 주석이 무엇이고, 왜 유용한지 알게 되었습니다. 다양한 프로그래밍 언어에서 주석을 추가하는 방법을 살펴보겠습니다.

한 줄 주석

// C/C++에서의 한 줄 주석입니다.

여러 줄 주석

/* C/C++에서의 약간 긴
여러 줄 주석입니다. */

한 줄 주석

# Python에서의 한 줄 주석입니다.

여러 줄 주석

# Python에서의 약간 긴
# 여러 줄 주석입니다.

한 줄 주석

// Java에서의 한 줄 주석입니다.

여러 줄 주석

/* Java에서의 약간 긴
여러 줄 주석입니다. */

한 줄 주석

# Ruby에서의 한 줄 주석입니다.

여러 줄 주석

=begin
Ruby에서의 약간 긴
여러 줄 주석입니다.
=end

한 줄 주석

// Golang에서의 한 줄 주석입니다.

여러 줄 주석

/* Golang에서의 약간 긴
여러 줄 주석입니다. */

한 줄 주석

-- Haskell에서의 한 줄 주석입니다.

여러 줄 주석

{- Haskell에서의 약간 긴
여러 줄 주석입니다. -}

한 줄 주석

// Rust에서의 한 줄 주석입니다.

여러 줄 주석

/* Rust에서의 약간 긴
여러 줄 주석입니다. */

한 줄 주석

<!-- HTML에서의 한 줄 주석입니다. -->

여러 줄 주석

<!-- HTML에서의 약간 긴
여러 줄 주석입니다. -->

한 줄 주석

/* CSS에서의 한 줄 주석입니다. */

여러 줄 주석

/* CSS에서의 약간 긴
여러 줄 주석입니다. */

한 줄 주석

// Javascript에서의 한 줄 주석입니다.

여러 줄 주석

/* Javascript에서의 약간 긴
여러 줄 주석입니다. */

한 줄 주석

# R 프로그래밍 언어에서의 한 줄 주석입니다.

여러 줄 주석

R은 여러 줄 주석을 지원하지 않습니다.

한 줄 주석

% Erlang에서의 한 줄 주석입니다.

여러 줄 주석

Erlang은 여러 줄 주석을 지원하지 않습니다.

한 줄 주석

// PHP에서의 한 줄 주석입니다.

여러 줄 주석

/* PHP에서의 약간 긴
여러 줄 주석입니다. */

한 줄 주석

# Perl에서의 한 줄 주석입니다.

여러 줄 주석

=begin
Perl에서의 약간 긴
여러 줄 주석입니다.
=end

한 줄 주석

// Kotlin에서의 한 줄 주석입니다.

여러 줄 주석

/* Kotlin에서의 약간 긴
여러 줄 주석입니다. */

결론

본 튜토리얼에서는 주석의 기본 개념과 일반적인 두 가지 유형인 한 줄 주석과 여러 줄 주석에 대해 알아보았습니다. 또한, 주석이 왜 유용한지, 필요한 상황에서 어떻게 작성해야 하는지에 대해서도 다루었습니다. 이 글을 통해 새로운 것을 배우셨기를 바랍니다!

계속 탐구하고, 꾸준히 학습하세요! 👨‍💻