C# 함수 설명 추가하기

※ 블로그를 이전하며 해당 내용을 개선하여 포스팅했습니다. (링크)

 

 

BCL을 사용해보면 함수를 사용하기 전에 어떤 기능을 하는 함수인지 설명을 해주는 글이 있습니다.

 

이를 직접 만든 함수에서 적용해 보겠습니다.

 

/// <summary>

///  Function for Applying All to Label

/// </summary>

/// <param name="lbl"></param>

public void ApplyAllToLabel(Label lbl)

{

lbl.FontFamily = FontFamily;

lbl.FontSize = FontSize;

lbl.FontStretch = FontStretch;

lbl.FontStyle = FontStyle;

lbl.FontWeight = FontWeight;

lbl.Foreground = Foreground;

}

 

위와 같은 함수가 있다고 할 때, summary를 추가해주면 함수를 호출할 때에 설명글이 뜹니다.

 

 

 

 

추가하는 간단한 방법은 아래와 같이 먼저 함수를 선언하고 바로 위 공간에 /// 를 치시면 자동으로 추가해줍니다.

 

public void ApplyAllToLabel(Label lbl)

{

 

}

 

(이러한 형태면 됨)

 

 

/// <summary>

///  

/// </summary>

/// <param name="lbl"></param>

 

이러한 형태로 추가가 됩니다. 혹시 자동으로 안된다면 직접 쳐주시면 됩니다.

여기서 summary 태그 내부에 있는 내용이 설명 부분이 되며, 함수뿐만이 아니라 변수에도 적용이 됩니다.

 

그리고 param 태그는 함수일 때 자동으로 추가해 줍니다. 함수 호출시에 매개변수 설명을 보여줍니다.