객체 브라우저 내에서 가독성을 손상시키지 않고 XML 주석 문서를 제공하려면 어떻게해야합니까?

Question

나는 <와 > 예를 > seealso 또는 < < 코드 > 같은 추가 항목을 추가하여 샌드캐슬 - 생성 된 클래스 라이브러리 참조 문서의 품질을 개선하기 위해 의견을 우리의 소스 코드의 일부를 개선하기 위해 노력하고 있습니다.

기본 XML 주석은 Object Browser와 SandCastle에서 생성 된 도움말 문서 모두에서 잘 작동합니다.

<seealso> 또는 < 예 : >과 같은 태그를 추가하면 개체 브라우저가 렌더링하는 끔찍한 작업을 수행합니다.

공용 클래스 의 TableView : : 여기 개체 브라우저에서 어떻게 표시되는지를 보여줍니다

C#을

/// <summary> 
    /// Represents the view mode that displays data in table layout 
    /// for the <see cref="ItemsMultiView"/> control 
    /// <remarks>This class must be used within an <see cref="ItemsMultiView"/>; 
    /// it cannot be used alone</remarks> 
    /// <example> 
    ///<para> 
    ///   The following example shows how to define a TableView 
    ///   to support the Table <see cref="ItemsMultiView.ViewMode" />. 
    ///   Note the use of <see cref="TableViewColumn.IsReadOnly" /> 
    ///   to disable editing ofcells on a per-column basis. 
    ///  </para> 
    ///  <code language="xml" xmlns:acme="http://schemas.acme.com/2010/xaml/presentation"> 
    ///   <acme:ItemsMultiView 
    ///    CanUserSortItems="True" 
    ///    ItemsSource="{Binding Employees}" 
    ///    SelectionMode="Multiple"> 
    ///<acme:ItemsMultiView.TableView> 
    /// <acme:TableView CanUserReorderColumns="True" 
    ///      CanUserResizeColumns="True"> 
    ///  <acme:TableView.Columns> 
    ///   <acme:TableViewTextColumn Binding="{Binding FirstName}" 
    ///          Header="First Name" 
    ///          IsReadOnly="True" /> 
    ///   <acme:TableViewTextColumn Binding="{Binding LastName}" 
    ///          Header="Last Name" 
    ///          IsReadOnly="True" /> 
    ///   <acme:TableViewDateColumn Binding="{Binding BirthDate}" 
    ///          DateMode="DateAndTime" 
    ///          Header="Birthday" /> 
    ///   <acme:TableViewCheckBoxColumn Binding="{Binding WorksWeekends}" Header="Works Weekends" /> 
    ///  </acme:TableView.Columns> 
    /// </acme:TableView> 
    ///</acme:ItemsMultiView.TableView> 
    ///</acme:ItemsMultiView> 
    ///  </code> 
    /// </example> 
    /// <seealso cref="5b8ce9ab-7703-4b85-8dbf-d74a2cc2fac3.htm"/> 
    /// </summary> 
    public class TableView : ViewBase 
    { 

: 여기

은 예입니다

을 Acme.Windows.Controls.ViewBase

의 회원 Acme.Windows.Controls

요약 :

ItemsMultiView는이 클래스가 ItemsMultiView 이내에 사용해야 제어용 테이블 레이아웃에 데이터를 표시하는 표시 모드를 나타내고; 단독으로 사용할 수 없습니다.

다음 예제에서는 Table ItemsMultiView.ViewMode를 지원하도록 TableView를 정의하는 방법을 보여줍니다. TableViewColumn.IsReadOnly를 사용하여 열 단위로 ofcells 편집을 비활성화하십시오. 5b8ce9ab-7703-4b85-8dbf-d74a2cc2fac3.htm

주의 :이 클래스는 ItemsMultiView 내에서 사용되어야합니다

; 단독으로 사용할 수 없습니다.

예 또는보기 cref 링크와 같은 항목의 렌더링을 지원하지 않는 것은 개체 브라우저의 제한 인 것으로 보입니다.

사실입니까? 그렇다면 부분적으로 표시하는 대신 문제를 일으키는 태그를 Object Browser가 완전히 무시하도록하려면 어떻게해야합니까?

내가 두 XML 주석의 버전 (개체 브라우저 호환성을 위해 하나, 및 샌드캐슬 문서 하나?)

Answer 1

위의 제대로 구성되지 않은 예제의 코드를 유지하는 데 필요한입니다. 요약 태그에는 요약 정보 만 포함되어야하며 다른 태그는 요약 태그의 형제로 존재해야합니다.

일단 수정하면 예상대로 동작합니다.