[Visual Studio] 누락된 XML 주석 경고 끄기

비주얼 스튜디오에는 주석의 내용을 XML 파일로 출력해주는 기능이 있습니다.

 

이렇게 생성된 XML은

1) 스웨거 같은 문서 생성 도구나

2) 직접 파싱하여 필요한 곳에 주석으로 붙이기

    예> 자동으로 'JSON'으로 출력한 코드에 주석 붙이기

등에 활용할 수 있습니다.

 

대신 이 기능을 활성화하면 주석이 없는 함수에 경고가 표시됩니다.

 

 

1. 문제의 발견

이게 보통 때는 문제가 없지만 'DB 마이그레이션 파일'과 같이 자동으로 생성되는 파일에도 경고가 난다는 것이 문제입니다.

 

그렇다고 하나하나 수작업할 수도 없는 노릇이고....

 

 

2. 해결 방법

옵션이 따로 있지는 않고 경고 예외를 걸어주면 됩니다.

 

프로젝트 속성 > 빌드 > 오류 및 경고

'1591' 추가

(참고 : MS Learn - 컴파일러 경고(수준 4) CS1591 )

 

 

마무리

참고 : stackoverflow - Visual Studio Disabling Missing XML Comment Warning -Gorgsenegger님 답변

 

이런 건 UI로 따로 해줘야 할 거 같은데.....

뭐, 직접 지정해서 제거해야 할 경고가 이것만 그런 건 아니니까요 ㅎㅎㅎㅎ

그러려니 합시다.