주석 Comment

웹이나 앱과 같이 개발을 하기 위해 특정 프로그래밍 언어를 이용하게 되면 코드 작성은 필수입니다. 그러나 종종 코드만으로는 다른 사람이나 나 자신이 코드를 이해하는 데 어려움이 있을 수 있습니다. 이럴 때 주석이 유용하게 활용됩니다. 주석은 코드에 설명이나 메모를 추가하여 코드의 의도를 명확하게 전달할 수 있습니다.

또한, 주석을 통해 코드의 특정 부분을 임시로 비활성화하거나 추후 수정할 계획을 기록하는 등의 용도로도 사용됩니다. 주석을 활용하여 코드를 보다 명확하고 유지보수하기 쉽게 만들 수 있습니다.

개요

주석(comment)은 소스 코드 내에서 프로그래머가 작성한 설명이나 메모로, 컴퓨터 프로그램이나 스크립트에서 실행되지 않습니다.

주석은 컴파일러나 인터프리터에 의해 무시되고 실행에 영향을 미치지 않는 코드입니다. 주석은 주로 코드를 이해하기 쉽게 만들거나, 코드의 특정 부분을 설명하는 역할을 하며, 프로그램의 이해도를 높이고 유지보수를 용이하게 만드는 데 도움을 줍니다.

주석은 코드의 가독성과 유지 보수성을 향상시키는 데 중요한 역할을 합니다. 따라서 개발자는 적절한 위치와 방식으로 주석을 작성하여 코드를 명확하고 이해하기 쉽게 만들어야 합니다.

DNS 캐시

주석의 특징

주석은 코드 실행에 영향을 미치지 않고 코드의 의도나 작동 방식을 설명하여 코드의 가독성을 향상시키는 역할을 합니다.

  • 비실행성: 주석은 코드를 실행할 때 무시되므로 컴파일러나 인터프리터에 의해 실행되지 않습니다. 이는 프로그램의 실행에 아무런 영향을 미치지 않는다는 것을 의미합니다. 주로 코드의 특정 부분을 설명하거나 임시로 비활성화할 때 사용됩니다.
  • 가독성 향상: 주석은 코드의 의도나 작동 방식을 설명하여 코드를 이해하기 쉽게 만듭니다. 다른 개발자나 나중에 자신이 코드를 다시 살펴볼 때 도움이 됩니다. 적절한 주석은 코드의 가독성을 높이고 유지 보수를 용이하게 만듭니다.
  • 코드의 일부: 주석은 주로 코드 내부에 작성되며, 해당 코드와 관련된 내용을 설명합니다. 이는 코드의 특정 부분에 대한 설명을 추가하거나 코드의 수정 이력을 기록하는 데 유용합니다.

주석의 종류

코드에 설명이나 메모를 추가하는데 사용는 주석은 간단한 설명을하는 한 줄 주석, 보다 자세한 설명을 추가할 때 사용되는 다중 줄 주석으로 구분해 볼 수 있습니다.

DNS 캐시

한 줄 주석(Single-line Comment)

# 이 부분은 리스트를 초기화하는 코드입니다.
items = []

// 이 부분은 변수를 선언하는 코드입니다.
int age = 25;

주로 한 줄의 설명이나 메모를 작성할 때 사용됩니다. 보통 소스 코드에서는 // 또는 #으로 시작합니다. 주요 언어들의 한 줄 주석 표시 방식은 다음과 같습니다.

언어한 줄 주석 형식예시
C, C++, C#, Java, JavaScript//// 이것은 한 줄 주석입니다.
Python## 이것은 한 줄 주석입니다.
PHP// 또는 #// 이것은 한 줄 주석입니다.
Ruby## 이것은 한 줄 주석입니다.

다중 줄 주석(Multi-line Comment)

/*
이 부분은
여러 줄에 걸쳐
설명하는 코드입니다.
*/

여러 줄에 걸쳐 설명이 필요할 때 사용됩니다. 주로 /**/ 사이에 작성됩니다. 주요 언어들의 다중 줄 주석 표시 방식은 다음과 같습니다.

언어여러 줄 주석 형식예시
C, C++/* ... *//* 이것은 여러 줄 주석입니다. */
C#/* ... */또는 ////* 이것은 여러 줄 주석입니다. */
Java/* ... *//* 이것은 여러 줄 주석입니다. */
JavaScript/* ... *//* 이것은 여러 줄 주석입니다. */
Python''' ... ''' 또는 """ ... """''' 이것은 여러 줄 주석입니다. '''
PHP/* ... *//* 이것은 여러 줄 주석입니다. */
Ruby=begin ... =end=begin 이것은 여러 줄 주석입니다. =end
마크다운

활용

주석은 코드의 기능을 설명하고 작성자 정보를 기록하며, 코드의 수정 이력을 추적하고 잠재적인 버그를 식별하는 데 사용됩니다.

  • 코드의 기능 설명: 주석은 코드의 기능을 설명하는 데 사용됩니다. 코드의 각 부분이 어떤 작업을 수행하는지 설명하여 다른 개발자가 코드를 이해하고 사용할 수 있도록 돕습니다.
  • 작성자 정보 및 작성 일자 기록: 주석을 통해 코드를 작성한 개발자의 정보와 작성 일자를 기록할 수 있습니다. 이는 코드의 소유권을 명시하고, 코드를 유지 보수하는 데 도움이 됩니다.
  • 코드의 수정 이력 기록: 주석을 사용하여 코드의 수정 이력을 기록할 수 있습니다. 코드가 수정될 때마다 어떤 변경이 있었는지를 기록하여 추후에 코드를 복구하거나 이전 상태로 되돌릴 수 있도록 합니다.
  • 잠재적인 버그나 개선 사항에 대한 메모: 주석은 코드에서 발견된 버그나 개선할 사항에 대한 메모를 작성하는 데 사용됩니다. 이러한 메모를 통해 나중에 코드를 개선하거나 버그를 수정하는 데 도움이 됩니다.

작성 시 주의사항

주석은 명확하고 간결하게 작성되어야 하며, 정확한 정보를 제공하고 최신 상태를 유지해야 합니다. 또한 과도한 사용은 피하고 필요한 경우에만 사용해야 합니다.

  • 명확하고 간결하게 작성: 주석은 코드를 이해하는 데 도움이 되어야 하므로 명확하고 간결하게 작성되어야 합니다. 불필요한 설명이나 혼란스러운 내용은 피해야 합니다.
  • 정확한 정보 제공: 주석은 정확한 정보를 제공해야 합니다. 잘못된 정보는 코드의 이해를 방해하거나 오류를 발생시킬 수 있으므로 주의가 필요합니다.
  • 최신 상태 유지: 코드를 수정할 때 주석도 함께 수정하여 최신 상태를 유지해야 합니다. 수정된 코드와 주석이 일치하지 않으면 혼란을 야기할 수 있습니다.
  • 과도한 사용 금지: 과도한 주석은 코드를 읽기 어렵게 만들 수 있으므로 필요한 경우에만 사용해야 합니다. 주석이 코드를 보완하고 명확하게 설명하는 데 도움이 되지만, 지나치게 사용될 경우 코드의 가독성을 저해할 수 있습니다.

관련글

Leave a Comment