C# Summary 기능 활용법 (꿀팁)

개발 하다보면 클래스는 따로 빼두고, 메서드도 비슷한 것 끼리 묶어서 클래스화하여 빼두는경우가 많다.

이때 외부에 있는 클래스나 웹메서드의 경우 찾아가기가 힘들어서 메서드의 목적이나 역할을 알아보기 힘들 수 있다.

이때 미리 작업해둘수 있는 좋은 방법이 C#의 Summary 기능이다. (말그대로 요약 기능이라고 생각하면 된다)

 

 

---

작성방법?

Utility.cs 클래스에 testMethod 라고 생성해준뒤, 위에서 /// (슬래쉬3번) 을 쳐주면 아래와같이 summary 구조가 자동으로 생성된다. 그리고 메서드의 제목에 대한 설명과 파라미터에 대한 설명을 아래와같이 적어주면 된다.

internal class Utility
    {
        /// <summary>
        /// 테스트용 메서드
        /// </summary>
        /// <param name="param1">첫번째 파라미터임(string)</param>
        /// <param name="param2">두번째 파라미터임(string)</param>
        public static void testMethod(string param1, string param2)
        {

        }
    }

 

 

 

 

---

 

예시)

위와같이 summary 작성을 완료한후, 다른곳에서 해당 메서드 위에 마우스 오버하게되면

아래와같이 미리 작성해둔 제목에 대한 설명이 출력된다.

 

 

 

 

 

그리고 첫번째 파라미터를 입력하려고 하는 순간 위와같이 param1 에 대한 기작성한 설명이 출력된다.

 

 

 

두번째 파라미터도 마찬가지다.

 

 

 

 

 

물론 메서드명과 파라미터 명에 영문의미를 따서 최대한 이름만으로 목적을 파악할 수 있게 하고 계시겠지만,,

가끔씩 메서드를 봐도 어떨때 쓰는건지 이해가 안될때가 있다. (혹은 주의사항을 주석해야한다거나)

그럴때 Summary 기능을 사용하면 아주 유용하다.