C# dll 파일을 외부에서 참조 추가 시 설명 보이게 하는 방법

이번에는 dll 파일을 만들어놓고 다른 프로젝트에서 참조시킬 때 기존에 추가했던 설명을 보이게 하는 방법에 대하여 알아보겠습니다. MS에서는 해당 설명을 '문서 주석' 이라는 명칭으로 사용합니다.

dll 파일을 개발하면서 summary 기능을 이용하여 아래와 같이 설명을 추가했습니다.

 

summary로 설명 추가

 

같은 프로젝트내에 있는 다른 cs 파일등에서 확인해보면 다음과 같이 설명이 잘 나옵니다.

 

설명이 나오는 모습

 

그러나 해당 내용이 담긴 dll 파일을 다른 프로젝트에서 참조하여 확인하면 다음과 같이 나타납니다.

 

설명이 나오지 않는 모습

 

분명 내부에서 사용하면 잘 나타나는데 외부에서 참조했더니 설명이 나오지 않습니다.

어떻게 해결해야 하는지 확인해보겠습니다.

먼저 dll 프로젝트의 속성으로 들어갑니다.

 

 

들어가서 빌드 탭을 클릭하면 아래에 출력 부분에 XML 문서 파일 항목이 있습니다.

해당 항목을 체크하고 빌드해줍니다.

 

 

체크 후 빌드하면 다음과 같이 XML 파일이 추가되어 빌드됩니다.

 

같이 추가된 XML 파일

 

그 다음 dll 파일과 XML 파일을 같이 참조할 프로젝트 폴더에 옮긴 후 참조 추가하면 됩니다.

추가하면 내부에서 나타났던것과 같이 설명이 잘 나타납니다.

dll 파일을 사용하는 중간에 추가하고 싶다면 맞는 XML 파일만 dll 파일이 있는 폴더에 옮기고 빌드해주면 됩니다.

 

그리고 XML 문서 파일에 체크를 하게되면 dll 프로젝트에서 경우에 따라서 아래와 같이 XML 주석이 없다는 경고가 발생합니다.

 

 

빌드에 지장은 없지만 경고문들이 거슬린다면 맞는 부분에 설명을 추가하거나

다음과 같이 프로젝트 속성의 빌드 탭에 있는 경고 표시 안 함 칸에 1591 값을 넣어주면 XML 주석에 대한 경고들만 사라집니다.

 

 

※ 참고 사항 ※

한 번 빌드해서 설명이 추가되면 이후 XML 파일을 제거해도 설명이 그대로 남아있는것을 확인했습니다.

그리고 중간에 XML 파일을 추가하니 일부 내용은 나타나지 않는 현상도 확인되었으나 무조건 발생하는지는 확인되지 않았습니다.

 

이상으로 C#에서 dll 참조 시 설명이 안 보이는 현상에 대한 해결법에 대하여 알아보았습니다.