코드 주석 달기

코드를 작성할 때, 특히 다른 사람들과 협업하거나 대규모 프로젝트를 다룰 때, 또는 개인적인 참고와 디버깅을 위한 코드 주석은 매우 중요합니다. GameMaker에서는 코드 섹션 및 전체 블록에 대한 메모와 주석을 남길 수 있는 다양한 메커니즘을 제공합니다. 이러한 기능을 통해 자신 또는 동료에게 코드를 설명하거나 복잡한 코드 조각에 대한 설명을 남길 수 있습니다. 또한, 미래에 무엇을 하기를 원하는지에 대한 알림을 남길 수도 있습니다.

## 1. 단일 주석

단순한 한 줄 주석을 남기려면 주석할 텍스트 앞에 `//`를 사용하면 됩니다.

```gml
// 변수 초기화
sr = 10;
hp = 100;

2. 다중 주석

다중 줄 주석은 다음과 같이 사용할 수 있습니다. 이는 신뢰를 주거나 전체 코드 섹션을 생략하거나 미래에 코드를 어떻게 변경할 것인지에 대한 메모를 남길 때 유용합니다.

/* GIF 변수를 초기 값으로 설정 (변경할 필요가 없는 경우 setter 함수를 사용하지 않아도 됩니다)
중요! 각각의 변수에 대한 추가 정보는 개별 "set" 스크립트를 참조하십시오.
*/
frame_num = 30;
frame_steps = 5;
frame_width = 256;
frame_height = 256;
frame_quality = gifcam_quality_high;

3. 코드 접기

주석과 함께 특별한 #region 태그를 사용하여 코드 섹션을 마크하고 코드 접기를 할 수 있습니다. 이를 통해 편집기에서 보이는 코드 줄 수를 줄일 수 있습니다.

#region 예시 지역
width = sprite_get_width(sprite);
height = sprite_get_height(sprite);
xoff = sprite_get_xoffset(sprite);
yoff = sprite_get_yoffset(sprite);
#endregion 추가 주석

4. 이벤트 설명

Object Editor에서 작업할 때, 이벤트 시작 부분에 주석을 추가하여 이벤트의 일반적인 내용을 설명하는 "설명" 주석을 사용할 수 있습니다. 이 주석은 코드 편집기의 첫 번째 줄에 위치해야 하며 다음과 같이 형식화됩니다.

/// @description <이벤트에 대한 설명>

이 주석은 이벤트 창에 표시됩니다.

5. 스크립트 함수 주석

스크립트 함수를 작성할 때 IDE의 자동 완성이나 스크립트 매개변수를 표시하는 방법에 대한 제어를 원한다면 JSDoc 형식을 사용하여 주석을 작성해야 합니다.

활용 및 응용 예제

아래는 다양한 상황에서 코드 주석을 활용하는 예제입니다.

이렇게 주석을 효과적으로 활용함으로써 코드의 가독성을 높이고 다른 개발자들이 이해하기 쉽게 할 수 있습니다. ```