주석으로 필드나 메서드 설명하기

Noke·2025년 6월 13일

Unity TIL

목록 보기
24/31

주석 처리를 통해, 타인에게 내 필드나 메서드를 설명할 수 있다.

그런데, 이 필드나 메서드에 마우스 포인터만 올려도 설명이 뜨게할 수 있는 기능이 있다는 사실!


📝 /// 주석처리

오 놀라운 발견

위와 같이, /// 처리를 하면 VS에서 자동적으로 저 summary 표시가 나오게 된다.

그러면, 아래에 해당 메서드에 대한 설명을 적으면 되는 것이다!!!
또한, 줄바꿈을 할 때는 <br/>을 붙이면 위의 사진과 같이 2줄짜리 설명도 가능하다.

<param name="damage"></param>의 사이에는 파라미터에 대한 설명도 추가할 수 있다.


✨ 마무리

오늘 데일리 스크럼을 하면서, 이러한 내용에 대해서 처음 알게 되었는데, 정말 유용하다.

여러분도 협업을 할 때, 위와 같이 주석 처리를 하여 모두한테 도움이 되는 개발자가 되도록 하자!!

profile
유니티 개발자(진)

0개의 댓글