Development Tip

/// summary 생성 방법

yourdevel 2020. 12. 14. 20:55
반응형

/// summary 생성 방법


Visual Studio에서 이러한 종류의 요약을 생성하려면 어떻게해야합니까?

/// <summary>
///  Returns a number
/// </summary>
/// <param name="num"></param>
/// <returns></returns>

///메서드, 속성 등을 입력 하기 전에 VS가 주석 블록을 자동으로 생성합니다.


다른 사람들이 말했듯이 Visual Studio는 기본적으로 멤버 선언 위의 행에 세 개의 슬래시를 입력하면 문서 템플릿을 자동으로 추가합니다. 멤버에 적용된 속성이있는 경우 속성 위의 줄에 슬래시를 입력합니다.

그러나 메서드 (또는 생성자, 속성 등)에 대해 문서화하는 데 가장 유용한 것 중 하나는 메서드가 생성 할 수있는 예외입니다. ///<exception나머지 문서 뒤에 입력하여 추가 할 수 있습니다 . Intellisense 제안을 수락하면 예외 유형에 대한 위치가 XML 속성으로 제공되며 예외 요소 콘텐츠에서 상황을 채울 수 있습니다.

문서가 이미 생성 된 후 메서드에 매개 변수가 추가 된 경우 Intellisense는 문서에 추가 할 때 새 매개 변수 이름을 채우는데도 매우 유용합니다. 꽤 매끄러운 기능입니다.


GhostDoc 과 같은 도구를 사용하십시오 . 메서드 이름을 마우스 오른쪽 버튼으로 클릭하면 생성됩니다.


이 작업을 더 쉽게하기 위해 GhostDoc추천 할 수 있습니다 .


/를 세 번 입력하면 Visual Studio가 나머지 코드를 채 웁니다.


문서화 할 메서드 나 클래스 바로 앞에있는 줄에 커서를 놓고 "///"를 입력합니다. Visual Studio에서 XML 문서 태그를 생성하고 세부 정보를 채울 수 있습니다.


George가 말했듯이 /// 바로 위의 줄에서 자동 생성됩니다.

상용구 주석 템플릿 외에도 사용할 수있는 다른 태그를 살펴 보는 것이 좋습니다. http://msdn.microsoft.com/en-us/library/5ast78ax.aspx

이것은 CHM 가이드 등을 자동으로 작성하기 위해 Sandcastle과 같은 다른 도구와 함께 사용할 수 있습니다.


속성 / 메서드 / etc 앞 줄에 ///를 입력하면 Visual Studio가 자동으로 XML 태그를 추가합니다.


컨트롤러의 경우 : 메소드 앞에 3 개의 슬래시를 사용합니다. 즉 /// 다음과 같은 요약 태그를 생성합니다

     /// <summary>
     /// 
     /// </summary>
     /// <param name="searchKey"></param>
     /// <returns></returns>

모델의 경우 : 자동 속성 앞에 3 개의 슬래시를 사용합니다. 즉 /// 다음과 같은 요약 태그를 생성합니다.

     /// <summary>
     /// 
     /// </summary>

참고 URL : https://stackoverflow.com/questions/6522889/how-to-create-summary

반응형