[Unity/C#] summary(///) 주석 사용법

c# 에서 가장 기본적인 주석이라고 한다고 // 을 통해서 생성되는 주석이라고 생각한다

사용법은 아래와 같이 사용을 하면 되는데

// 주석은 이렇게 사용합니다.

// 을 입력하면 작성한 해당 줄이 주석으로 처리된다

 

해당 주석 이외에도 서적이나 문서에서 보면 /// <summary> 로 되어 있는 주석을 볼 수 있다

    /// <summary>
    /// 
    /// </summary>
    private void Test()
    {
        
    }

함수나 변수를 작성하고 그 위에 /// 를 입력하면 자동으로 함수에 맞춰서 주석이 생성되게 되는데

위와 같이 ///만 입력을 하였음에도 <summary>로 묶이며 양식이 자동으로 생성이 된다.

 

    /// <summary>
    /// 함수의 정보를 입력합니다
    /// </summary>
    /// <param name="num">매개변수 설명</param>
    /// <returns>리턴 값 설명</returns>
    private string Test(int num)
    {
        return "abc";
    }

 

함수의 모습에 따라 매개변수나 리턴 값에 따라 새로운 항목들이 추가되게 되는데

해당 주석 안에 설명을 넣어주어 사용하게 된다