C# 주석에 대한 XML 태그

🟦 XML 태그

- summary 기능을 사용하면 메서드와 파라미터에 대한 설명이 뜨기 때문에 더욱 편리하다.

XML 문서 주석 - /// 주석을 사용하여 API 문서화

XML 문서 주석에 대해 알아봅니다. 특수 주석 필드에 XML 요소를 넣어 코드의 설명서를 만들 수 있습니다. 다른 도구를 사용하여 주석에서 문서 레이아웃을 빌드할 수 있습니다.

docs.microsoft.com

- 슬래시( / ) 세번 입력 후 <summary> 태그 입력

- 주석으로 입력할 부분 모두 슬래시 3번을 앞에 입력해줘야한다.

- summary 태그 안에 클래스에 대한 설명을 작성

- 다른 스크립트에서 해당 클래스를 선언할 때 summary로 작성했던 주석이 나타난다.

- 함수에 대해서도 주석을 달 수 있다.

- summary : 클래스와 마찬가지로 함수에 대한 설명

- param : 인자에 대한 설명

- returns : 반환값에 대한 설명

- 메서드를 호출할 때 주석에 작성한 내용들이 뜬다.