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)
답변
“3 개의 단일 주석 마커”를 만드십시오.
C #에서는 ///
기본값은 다음과 같습니다.
/// <summary>
///
/// </summary>
/// <returns></returns>
답변
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.
기억하십시오 : 문서에 메소드 서명 이외의 정보를 추가해야합니다. 자동 생성 된 문서에 그치지 마십시오. 이와 같은 도구의 가치는 메서드 서명에서 추출 할 수있는 문서를 자동으로 생성하므로 추가하는 모든 정보는 새로운 정보 여야한다는 것 입니다.
즉, 저는 개인적으로 메소드가 완전히 자체 문서화되는 것을 선호하지만 때로는 외부 문서화를 요구하는 코딩 표준이 있으며 이와 같은 도구를 사용하면 많은 수고한 타이핑을 줄일 수 있습니다.
답변
///
메서드 설명 주석 블록을 가져 오는 바로 가기입니다. 그러나 추가하기 전에 함수 이름과 서명을 작성했는지 확인하십시오. 먼저 함수 이름과 서명을 작성하십시오.
그런 다음 함수 이름 위에 ///를 입력합니다.
그리고 당신은 그것을 자동으로 얻을 것입니다
답변
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 ++, 유형 : 리팩토링을 선택한 다음 ‘문서 방법’으로 이동하여 사용자 지정합니다. 위의 예는 다음에 의해 생성됩니다.
답변
일반적으로 Visual Studio는 주석 처리하려는 항목 (메서드, 클래스) 위에 세 개의 단일 주석 마커를 추가하면 자동으로 생성됩니다.
C #에서는 ///.
Visual Studio가이 작업을 수행하지 않으면 다음에서 활성화 할 수 있습니다.
옵션-> 텍스트 편집기-> C #-> 고급
그리고 확인
///에 대한 XML 문서 주석 생성
답변
Visual Basic에서 먼저 함수 / 서브를 만든 다음 그 위 줄에 ‘를 세 번 입력하면 문서화를위한 관련 xml이 자동 생성됩니다. 이것은 또한 당신이 intellisense에서 마우스 오버 할 때 그리고 당신이 기능을 사용할 때 나타납니다.
답변
코드 조각을 사용하여 원하는 줄을 삽입 할 수 있습니다.
또한 함수 헤더 위의 줄에 세 개의 작은 따옴표 ( ” ‘)를 입력하면 채울 수있는 XML 헤더 템플릿이 삽입됩니다.
이러한 XML 주석은 설명서 소프트웨어에서 해석 할 수 있으며 빌드 출력에 assembly.xml 파일로 포함됩니다. 해당 XML 파일을 DLL과 함께 유지하고 다른 프로젝트에서 해당 DLL을 참조하면 해당 주석을 intellisense에서 사용할 수 있습니다.
