CSDL을 사용하여 엔티티 문서화

Question

CSDL에는 엔티티를 문서화하는 데 사용할 수있는 according to MSDN 문서/요약 및 문서/LongDescription 요소가 포함되어 있습니다. 이러한 요소의 내용은 엔티티 디자인 화면의 속성 창에 편리하게 표시되므로 엔터티를 사용하면서이 필드에 몇 개의 노트를 쉽게 메모 할 수 있습니다.

EDMX 파일이 XML이므로 XSLT 스타일 시트를 작성하여 이러한 요소의 문서를 쉽게 가져올 수 있습니다. 이 작업을 수행하기위한 표준 도구가 있습니까? CSDL 문서 필드를 사용할 때 다른 이점이 있습니까? 이 필드를 사용하는 사람이 누구인가요? 그렇다면 엔티티를 문서화하는 효과적인 방법이라는 것을 알았습니까?

Answer 1

CSDL에 저장된 문서 데이터는 생성 된 코드에서 XML 문서 주석으로 방출됩니다. 당신은 당신이 (우수한 프론트 엔드 SHFB와 선택적으로 함께) SandCastle을 사용할 수 있습니다 더 공식적인 문서를 위해 그것을 사용하려는 경우

를, 또는 : 결과적으로, 자동적으로 Visual Studio에서 IntelliSense를 툴팁에 표시됩니다 일부 다른 Xml DocComment 추출 도구는 Windows 도움말 파일을 만들거나 문서가 포함 된 웹 사이트를 도울 수 있습니다. 데이터베이스가 문서를 사용하여 문서화 된 SQL 서버 속성 경우

, 당신은 데이터베이스에서 해당 문서를 추출하고이 도구를 사용하여 SSDL 및 CSDL 의견을 채울 수 있습니다 : http://huagati.com/edmxtools/