[Visual Studio] summary로 함수 사용 시 주석 내용 표시하기

#include <stdio.h>

void test();

int main(int argc, char *argv[])
{
	test();
	
	return 0;
}

/// <summary>
/// <para>summary 테스트 입니다.</para>
/// <para>이렇게 하면 함수 사용 시 설명을 표시해줄 수 있습니다.</para>
/// <para>또한 para를 사용하면 이렇게 단락을 구분 지어줄 수 있습니다.</para>
/// </summary>
void test()
{
	return;
}

XML 예약문자

<, >, &는 XML tag 표시와 entity를 표시하는 XML 예약문자로, XML 문서에 그대로 사용할 수 없다.
< (less-than sign) &lt;
> (greater-than sign) &gt;
& (ampersand) &amp;

이렇게 코딩을 하면 아래 이미지와 같이 함수 사용 시에 함수 원형과 함께 설명이 보여진다.
(함수 매개변수 입력하는 () 사이에서 Ctrl + Shift + SpaceBar를 눌러도 나타남.)



Visaul Studio 2015에서는 안 되는것 같고, 그냥 함수 위에 주석으로 달아 놓으면 위 이미지처럼 표시된다.

댓글

이 블로그의 인기 게시물

[NSIS] 32비트와 64비트 모듈 등록하는 법. (regsvr32)

[Visual Studio] Windows 7 에서 Visual Studio 6.0 디버그 시 프로세스 좀비되는 증상 해결 방법