[Unity 개발] C# 코드 주석 달기

현재 소프트웨어 마에스트로에서 협업 작업을 진행 중에 있다.

멘토님의 조언에 따라 코드의 주석을 추가하기로 했고,

우리 팀의 경우 public으로 열려있는 메서드에 주석을 추가하기로 그라운드 룰을 정했다.

찾아보니 MS에서 권장하는 주석 작성법이 존재했고 이를 따라 작성하기 위해 정리하여 올려본다.

 

 

 

---

빠르게 사용하기

Visual Studio에 주석을 작성하고 싶은 코드 위에 ///를 입력하면 알맞게 자동 생성된다.

다음과 같은 코드가 있을 때,

현재 주석이 보이는 위치에 ///를 입력하는 순간 

위와 같은 주석들이 자동 생성된다.

자동 생성된 주석의 서식에 따라 내용을 채워주면 된다.



이처럼 주석을 작성해주면

다음과 같이 설명이 뜨는 것을 확인할 수 있다.

이렇게 하면 빠르게 주석을 작성하는 것은 끝이다.

 

 

 

 

---

태그

기본적인 태그 몇 개만 정리했다.

 

<summary>

<summary>
state가 현재 handler에 들어있는 경우 <br />
해당하는 handler의 인터페이스를 반환해준다.
</summary>

<summary> 태그를 사용하여 클래스 및 해당 멤버를 설명한다.

<summary> 태그의 텍스트는 IntelliSense의 형식에 대한 유일한 정보 소스로 개체 브라우저 창에도 표시된다.

여러 줄이 필요한 경우 <br /> 태그를 사용하면 된다.

 

 

<returns>

<returns>현재 핸들러에 없는 경우 null, 유효한 경우 해당 인터페이스 반환</returns>

<returns> 태그는 메서드 선언의 주석에서 반환 값을 설명하는 데 사용된다.

 

 

<param>

<param name="state">가져오고 싶은 state handler</param>

<param> 태그는 메서드의 매개 변수 중 하나를 설명한다.

name : 메서드 매개 변수의 이름으로 큰따옴표("")로 묶는다. 매개 변수의 이름은 API 시그니처와 일치해야 한다.

 

 

 

---

공식 문서

 

이 글은 Microsoft 문서를 보고 정리했다.

https://docs.microsoft.com/ko-kr/dotnet/csharp/language-reference/xmldoc/recommended-tags

클래스 및 해당 멤버에 대한 권장 XML 문서 태그