XML 주석활용하기-내가 짠 함수에 대한 설명이 보이게

프로그램 작성시 중요한 것 중의 하나가 주석을 적절하게 다는 것이다.
이제 주석 처리가 VB.NET 2005에 들어오면서 획기적으로 발전하였다. 단순한 주석에서 머무르지 않고 이제는 XML 주석을 통해 각 코드에 구조화된 주석을 쉽게 첨가할 수 있게 되었다. 주석을 작성할 때 각 요소들의 상단에 작은따옴표 3개(”’)를 입력하면(원래 비베의 주석은 작은따옴표 한 개면 됨) [그림1]과 같이 자동으로 XML 주석이 생성되는 것을 확인 할 수 있다.


[그림 1] 비베20005에서 XML 자동 주석 달기

해당 요소에 대한 XML 주석 작성 후 다른 곳에서 그 요소를 참조하게 되면 작성된 XML 주석의 내용이 인텔리센스로 표현되어 코딩시 혼동을 방지할 수 있다. 

[그림2], [그림3]은 작성된 XML 주석이 참조시 사용되는 예이다.

[그림 2] XML 주석의 활용 – 첫째 인자에 대한 설명이 나옴

 
[그림 3] XML 주석의 활용 – 둘째 인자에 대한 설명이 나옴

[For your information]
Visual Basic에서는 프로젝트를 빌드할 때 자동으로 XML 설명서 파일을 생성합니다. 이 파일은 응용 프로그램 출력 디렉터리에 AssemblyName.xml로 나타납니다. 이 파일은 XML 파일이므로 필요할 경우 다른 출력 형식으로 쉽게 변환할 수 있습니다. XML 주석을 사용하면 쉽고 편리하게 코드 설명서를 생성할 수 있습니다. 즉, 코드를 작성하는 동안에는 IntelliSense로, 응용 프로그램을 빌드한 후에는 코드 설명서로 생성할 수 있습니다. (출처 : Visual Basic 2005의 언어 향상)

Print Friendly, PDF & Email
%d bloggers like this: