3.5 주석 (Comment)

주석(comment)은 소스 코드에 설명이나 메모를 작성하는 기능입니다. 주석으로 작성된 내용은 프로그램의 실행에 영향을 주지 않으며, 컴파일러는 이 부분을 무시합니다. 주석의 주된 목적은 코드를 읽는 사람의 이해를 돕는 데 있습니다.

Ada에서 주석은 두 개의 하이픈(--)으로 시작하며, 그 지점부터 해당 줄의 끝까지 모든 내용이 주석으로 처리됩니다.

사용 예시

주석은 한 줄 전체를 차지할 수도 있고, 코드 뒤에 위치할 수도 있습니다.

-- 이 줄 전체는 주석입니다.
-- 변수 x에 초기값을 할당합니다.
x : Integer := 1;  -- 변수 선언과 동시에 값을 1로 설정

-- 여러 줄에 걸쳐 주석을 작성할 경우,
-- 각 줄을 '--'로 시작합니다.

빈 줄 사이에 주석을 사용하여 코드의 논리적 구역을 구분하기도 합니다.

-- 변수 초기화
x : Integer := 0;

-- 반복문 시작
for i in 1 .. 10 loop
  x := x + i;
end loop;

주석의 역할

주석은 다음과 같은 역할을 수행합니다.

• 코드 의도 설명: 코드의 동작 방식('무엇을')과 더불어, 설계 배경('왜')과 같은 개발자의 의도를 설명합니다.
• 로직 해설: 특정 알고리즘이나 비즈니스 규칙을 설명하여 코드의 유지보수를 지원합니다.
• 임시 코드 비활성화 (주석 처리): 특정 코드 라인을 실행에서 제외할 목적으로 해당 라인 앞에 --를 붙여 비활성화할 수 있습니다. ada -- x := x + 1; -- 이 라인은 주석 처리되어 실행되지 않음 y := y + 1;
• 자동화 도구를 위한 정보 제공: 문서 생성 도구나 코드 분석 도구는 특정 형식의 주석을 입력으로 사용합니다. 이러한 도구들은 주석을 읽어 API 문서를 생성하거나 코드의 정확성을 검증하는 데 사용합니다.

주석은 코드의 가독성과 유지보수성을 향상시킬 수 있으며, 협업에 활용될 수 있습니다.