대의원 선언 이벤트에 대한 XML 의견
-
20-09-2019 - |
문제
이전 코드를 방문하고 있으며 Eventhandler를 사용하지 않고 수동으로 대표자와 함께 선언 된 이벤트가 있습니다.u003CT> , 이와 같이:
/// <summary>
/// Delegate for event Added
/// </summary>
/// <param name="index">Index of the item</param>
/// <param name="item">The item itself</param>
public delegate void ItemAdded(int index, T item);
/// <summary>
/// Added is raised whenever an item is added to the collection
/// </summary>
public event ItemAdded Added;
Sandcastle을 사용하여 라이브러리를 문서화하기 위해 올 때까지 모든 것이 좋습니다. 이벤트 선언에서 생성 된 개인 추가 필드에 대한 XML 댓글을 찾을 수 없기 때문입니다. 나는 그것을 시도하고 정리하고 싶지만, 내가하고 싶은 것은 다음과 같습니다.
- Sandcastle이 모든 개인 필드를 완전히 무시하라고 지시하지 않고 자동 생성 된 개인 필드를 무시하도록하십시오.
또는
- 개인 분야에 대해 XML 주석을 생성하십시오
코드가 다음과 같이 보이도록 다시 요약하지 않고이를 달성하는 방법이 있습니까?
/// <summary>
/// Delegate for event <see cref="Added"/>
/// </summary>
/// <param name="index">Index of the item</param>
/// <param name="item">The item itself</param>
public delegate void ItemAdded(int index, T item);
/// <summary>
/// Private storage for the event firing delegate for the <see cref="Added"/> event
/// </summary>
private ItemAdded _added;
/// <summary>
/// Added is raised whenever an item is added to the collection
/// </summary>
public event ItemAdded Added
{
add
{
_added += value;
}
remove
{
_added -= value;
}
}
해결책
하위 최적이지만이 주위에 XML 주석을 수동으로 프로젝트에 대한 네임 스페이스 레벨 문서를 포함하는 파일에 수동으로 넣는 방법을 찾았습니다.
<member name="F:myCompany.Common.Collections.Generic.EventableCollection`1.Added">
<summary>
Auto-generated backing field for the <see cref="E:myCompany.Common.Collections.Generic.EventableSortedList`1.Added">Added</see> event
</summary>
</member>
이것은 내가 필요한 것을 대략적으로 제공합니다.
제휴하지 않습니다 StackOverflow