Unity C# XML 주석 param 태그

C# XML 주석 param 태그 요약

1. 개요

<param> 태그는 메서드의 매개변수를 문서화할 때 사용하는 XML 주석입니다.

• ///(트리플 슬래시)로 시작하며, 코드의 IntelliSense 및 API 문서 생성 시 활용됨.
• param 태그에는 매개변수 이름과 설명을 작성.

2. 기본 사용법

/// <summary>
/// 두 개의 숫자를 더합니다.
/// </summary>
/// <param name="a">첫 번째 숫자</param>
/// <param name="b">두 번째 숫자</param>
/// <returns>두 숫자의 합</returns>
public int Add(int a, int b)
{
    return a + b;
}

IntelliSense에서 설명 표시됨

3. 다양한 XML 주석과 함께 사용

/// <summary>
/// 플레이어를 이동시킵니다.
/// </summary>
/// <param name="x">X 좌표</param>
/// <param name="y">Y 좌표</param>
/// <param name="speed">이동 속도</param>
/// <returns>이동 결과 (성공/실패)</returns>
/// <remarks>
/// 속도는 0보다 커야 합니다.
/// </remarks>
/// <example>
/// <code>
/// MovePlayer(10, 5, 2.0f);
/// </code>
/// </example>
public bool MovePlayer(float x, float y, float speed)
{
    if (speed <= 0) return false;
    transform.position = new Vector3(x, y, transform.position.z);
    return true;
}

태그	설명
<summary>	메서드의 간단한 설명
<param>	매개변수 설명
<returns>	반환값 설명
<remarks>	추가 참고 사항
<example>	예제 코드 포함

4. Unity에서의 활용 예시

(1) Vector3를 이용한 이동 함수

/// <summary>
/// 오브젝트를 이동시킵니다.
/// </summary>
/// <param name="target">이동할 대상 위치</param>
/// <param name="speed">이동 속도</param>
public void MoveTo(Vector3 target, float speed)
{
    transform.position = Vector3.MoveTowards(transform.position, target, speed * Time.deltaTime);
}

(2) 씬 변경 함수

/// <summary>
/// 씬을 비동기 로딩합니다.
/// </summary>
/// <param name="sceneName">로딩할 씬 이름</param>
/// <param name="delay">로딩 전 대기 시간 (초)</param>
public IEnumerator LoadSceneAsync(string sceneName, float delay)
{
    yield return new WaitForSeconds(delay);
    SceneManager.LoadSceneAsync(sceneName);
}

 

5. 요약

▶ <param>: 매개변수 설명을 문서화할 때 사용.
▶  <returns>: 반환값 설명 포함 가능.
▶  IntelliSense에서 주석이 표시되어 개발자가 쉽게 이해 가능.
▶  Unity에서도 활용 가능, 특히 유틸리티 함수, AI 이동, 씬 로딩 함수 등에 적용 추천.