내일배움캠프 48일차 TIL "Summary 기능"

 

기본적으로 주어지는 메서드들은 메서드의 기능에 대한 설명과, 각 매개변수들이 어떤 것인지에 대한 설명이 있는 경우가 있다.

그러나 작업을 하다보면 자신이 만든 메서드를 사용하게 되는 경우가 있는데, 이 경우는 따로 설명이 적혀져 있지 않다.

 

혼자 작업하는 경우면 큰 문제가 없을 수도 있지만, 여러 사람과 협업을 할 경우, 내가 만든 이 메서드가 어떤 역할을 하는지, 어떤 매개변수가 구체적으로 어떤 역할을 하는지 등을 일일이 설명하기 힘든 경우도 존재한다.

 

C#에서는 Summary기능을 이용해 메서드에 설명을 직접 입력을 할 수 있다.

 

 

 

 

비주얼 스튜디오를 기준으로, '/'를 세번 입력할 경우, 자동으로 summary 양식이 작성된다.

 

 

자동완성된 summay 양식

 

이때, <summary>와 </summary> 사이에 해당 메서드에 대한 설명을 입력할 수 있고,

매개변수 부분도 <param name="매개변수이름">과 </param>사이에 입력해 줄 수 있다.

 

위 코드를 기준으로 설명을 작성한다면 밑 코드블럭과 같을 것이다.

 

/// <summary>
/// 일어나는 시각으로 초기화하는 메서드
/// </summary>
/// <param name="p_awakeUpTime">일어날 시간 입력</param>
private void ResetInGameTime(int p_awakeUpTime)
{
    _inGameHour = p_awakeUpTime;
    _inGameMinute = 0;
    _lastCheckedRealTime = 0f;
}

 

 

 

메서드에 대한 설명이 반영된 모습

매개변수에 대한 설명이 표시되는 모습

 

그러면 해당 메서드를 처음 보는 사람이라도, summary가 없었을 때와 비교한다면 비교적 쉽게 해당 메서드에 대해 빠르게 파악을 할 수 있다.