2011. 3. 10. 20:56
SHFB에서 namespace의 문서 작성하기 카테고리 없음2011. 3. 10. 20:56
SHFB(Sandcastle Help File Builder)를 이용하여 .NET 프로젝트 문서화를 할 때(코드주석 문서화하자 참조) namespace에 해당하는 페이지에서는 항상 문서화 주석이 없다는 붉은 오류 메시지가 포함되어 상당히 보기 안좋았는데, 오늘 잠깐 검색을 해서 방법을 찾았습니다. 이것은 SHFB에 포함된 도움말의 색인에서 NamespaceDoc class 항목을 찾아보면 볼 수 있는 내용입니다.
해당 네임스페이스에 NamespaceDoc 이라는 클래스를 만들고 그 클래스에 문서화 주석을 달면 SHFB가 빌드할 때 네임스페이스 도움말로 바꿔줍니다. 아래와 같은 코드를 만드는거죠.
{ /// <summary> /// 이 네임스페이스로 말할 것 같으면, 아무튼 멋지구리하다는 것! /// </summary> [System.Runtime.CompilerServices.CompilerGenerated] } }
이렇게 써주면 TheNamespace 에 해당하는 도움말 페이지에는 NamespaceDoc 클래스의 문서화 주석 내용이 표시되는 겁니다. 이제 더이상 별로 보기 안 좋은 붉은 글씨를 안 봐도 되겠네요!
댓글을 달아 주세요