Visual Studio에서 함수 설명서 자동 생성


91

Visual Studio에서 자동 생성 함수 헤더를 만드는 방법 (키보드 단축키)이 있는지 궁금합니다.

예:

Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

그리고 그것은 자동적으로 이렇게 될 것입니다 ...


'---------------------------------- 
'Pre: 
'Post:
'Author: 
'Date: 
'Param1 (String): 
'Param2 (Integer): 
'Summary: 
Private Function Foo(ByVal param1 As String, ByVal param2 As Integer)

1
IDE에서이 기능이 손상된 것 같아서이 페이지를 방문한 경우 코드가 컴파일되었는지 확인하고 다시 시도해야합니다. 이 기능은 코드에 구문 분석 오류가있는 경우 작동하지 않습니다.
krowe2

Xamarin에서 할 일 목록을 생성하는 방법은 무엇입니까?
Manthan

답변:


160

"3 개의 단일 주석 마커"를 만드십시오.

C #에서는 ///

기본값은 다음과 같습니다.

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

다음은 VS 템플릿 편집에 대한 몇 가지 팁입니다.


7
그리고 VB.NET에서는 (다른 답변에서 언급했듯이) 세 개의 작은 따옴표입니다
peSHIr

1
그것은 꽤 깔끔하고 그것에 대해 몰랐습니다
Brendan

이전 공백이 아닌 줄이 "///"로 시작하는 경우 "///에 대한 XML 문서 주석 생성"이 작동하지 않습니다.
Moon Waxing

모든 메서드, 속성 및 변수에서이 작업을 자동으로 수행 할 수 있습니까? 코드가 이미 존재하더라도?
Robin Bruneel

팁 링크가 다시 수정 되었습니다 . 저주, 단방향 웹!
Michael Paulukonis

48

GhostDoc !

함수를 마우스 오른쪽 버튼으로 클릭하고 "문서화"를 선택한 다음

private bool FindTheFoo(int numberOfFoos)

된다

/// <summary>
/// Finds the foo.
/// </summary>
/// <param name="numberOfFoos">The number of foos.</param>
/// <returns></returns>
private bool FindTheFoo(int numberOfFoos)

(예, 모두 자동 생성됩니다).

C #, VB.NET 및 C / C ++를 지원합니다. 기본적으로 Ctrl+ Shift+에 매핑됩니다 D.

기억하십시오 : 문서에 메소드 서명 이외의 정보를 추가해야합니다. 자동 생성 된 문서에 그치지 마십시오. 이와 같은 도구의 가치는 메서드 서명에서 추출 할 수있는 문서를 자동으로 생성하므로 추가하는 모든 정보는 새로운 정보 여야한다는 것 입니다.

즉, 저는 개인적으로 메소드가 완전히 자체 문서화되는 것을 선호하지만 때로는 외부 문서화를 요구하는 코딩 표준이 있으며 이와 같은 도구를 사용하면 많은 수고한 타이핑을 줄일 수 있습니다.


16
그리고 이것은 내가 혐오하는 일종의 '문서'입니다. 메서드 및 매개 변수 이름이 아직 알려주지 않는 것을 알려주지 않고 바이트를 추가합니다. 코멘트를 편집하지 않고는 이렇게하지 마십시오 ... :-(
peSHIr

12
물론 정보를 추가하려면 편집해야합니다. 그러나 템플릿으로 매우 좋습니다.
Rasmus Faber

3
@Rasmus : 좋은 문서화를 위해서는 정보 콘텐츠가 없기 때문에 완전히 버리고 어쨌든 다시 작성해야하는 템플릿입니다. 따라서 실제로는 공백보다 더 많은 노력이 필요합니다.
Joey

36
///

메서드 설명 주석 블록을 가져 오는 바로 가기입니다. 그러나 추가하기 전에 함수 이름과 서명을 작성했는지 확인하십시오. 먼저 함수 이름과 서명을 작성하십시오.

그런 다음 함수 이름 위에 ///를 입력합니다.

그리고 당신은 그것을 자동으로 얻을 것입니다

여기에 이미지 설명 입력


5
특이한 포스트 기능, 애니메이션.
n611x007

1
당신은 그렇게 않았다 방법? 나는 그 대답을 좋아합니다. 전에 본 적이 없습니다.
Matthis Kohli

2
좋아요. 하나의 추가는 함수에 대한 매개 변수입니다.
amit jha

19

Visual Assist에는 좋은 솔루션 도 있으며 비용이 많이 듭니다.

doxygen 스타일 주석을 생성하도록 조정 한 후이 두 번의 클릭은 다음을 생성합니다.

/**
* Method:    FindTheFoo
* FullName:  FindTheFoo
* Access:    private 
* Qualifier:
* @param    int numberOfFoos
* @return   bool
*/
private bool FindTheFoo(int numberOfFoos)
{

}

(기본 설정에서는 약간 다릅니다.)


편집 : '문서 방법'텍스트를 사용자 지정하는 방법은 VassistX-> Visual Assist 옵션-> 제안, 'VA 스 니펫 편집', 언어 : C ++, 유형 : 리팩토링을 선택한 다음 '문서 방법'으로 이동하여 사용자 지정합니다. 위의 예는 다음에 의해 생성됩니다.

va_doxy


버지니아에서 어떻게 설정했는지 공유해주세요
Damian

대답에 대해 자세히 설명했습니다. 도움이 되었기를 바랍니다.
Ofek Shilon 2016

스 니펫을 삽입하려면 : 메소드 이름 / 서명에 커서를두고 alt + shift + q> "문서 메소드"
Andrew

13

일반적으로 Visual Studio는 주석 처리하려는 항목 (메서드, 클래스) 위에 세 개의 단일 주석 마커를 추가하면 자동으로 생성됩니다.

C #에서는 ///.

Visual Studio가이 작업을 수행하지 않으면 다음에서 활성화 할 수 있습니다.

옵션-> 텍스트 편집기-> C #-> 고급

그리고 확인

///에 대한 XML 문서 주석 생성

사진 설명


3

Visual Basic에서 먼저 함수 / 서브를 만든 다음 그 위 줄에 '를 세 번 입력하면 문서화를위한 관련 xml이 자동 생성됩니다. 이것은 또한 당신이 intellisense에서 마우스 오버 할 때 그리고 당신이 기능을 사용할 때 나타납니다.


2

코드 조각을 사용하여 원하는 줄을 삽입 할 수 있습니다.

또한 함수 헤더 위의 줄에 세 개의 작은 따옴표 ( '' ')를 입력하면 채울 수있는 XML 헤더 템플릿이 삽입됩니다.

이러한 XML 주석은 설명서 소프트웨어에서 해석 할 수 있으며 빌드 출력에 assembly.xml 파일로 포함됩니다. 해당 XML 파일을 DLL과 함께 유지하고 다른 프로젝트에서 해당 DLL을 참조하면 해당 주석을 intellisense에서 사용할 수 있습니다.


이것이 VB.NET입니다. C #에서는 ///
peSHIr

0

저는 파일을 저장할 때 자동으로 적절한 문서 출력을 생성하기 위해 단어를 분석하는 Todoc이라는 오픈 소스 프로젝트를 진행하고 있습니다. 기존 댓글을 존중하며 정말 빠르고 유동적입니다.

http://todoc.codeplex.com/

당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.