Documentation 요소(CSDL)

아티클
03/02/2011

CSDL(개념 스키마 정의 언어)의 Documentation 요소를 사용하면 부모 개체에 정의된 개체에 대한 정보를 제공할 수 있습니다. .edmx 파일에서 Documentation 요소가 엔터티, 연결 또는 속성과 같이 엔터티 데이터 모델 디자이너의 디자인 화면에 개체로 나타나는 요소의 자식인 경우 Documentation 요소의 콘텐츠가 개체에 대한 Visual Studio 속성 창에 나타납니다.

Documentation 요소는 다음에 나열된 순서대로 자식 요소를 포함할 수 있습니다.

Summary: 부모 요소에 대한 간단한 설명입니다. (0개 또는 한 개의 요소)
LongDescription: 부모 요소에 대한 자세한 설명입니다. (0개 또는 한 개의 요소)
Annotation 요소 (0개 이상의 요소)

적용 가능한 특성

주석 특성(사용자 지정 XML 특성)을 원하는 수만큼 Documentation 요소에 적용할 수 있습니다. 그러나 사용자 지정 특성은 CSDL에 예약된 XML 네임스페이스에 속할 수 없습니다. 두 사용자 지정 특성의 정규화된 이름은 서로 같을 수 없습니다.

예제

다음 예제에서는 Documentation 요소를 EntityType 요소의 자식 요소로 보여 줍니다. 다음의 코드 조각이 .edmx 파일의 CSDL 콘텐츠에 있는 경우 사용자가 Customer 엔터티 형식을 클릭하면 Summary 및 LongDescription 요소의 콘텐츠가 Visual Studio 속성 창에 나타납니다.

<EntityType Name="Customer">
   <Documentation>
     <Summary>Summary here.</Summary>
     <LongDescription>Long description here.</LongDescription>
   </Documentation>
   <Key>
     <PropertyRef Name="CustomerId" />
   </Key>
   <Property Type="Int32" Name="CustomerId" Nullable="false" />
   <Property Type="String" Name="Name" Nullable="false" />
</EntityType>

다음을 통해 공유

Documentation 요소(CSDL)

적용 가능한 특성

예제

참고 항목

개념

기타 리소스

추가 리소스