Правильно документируйте делегатов событий C#

Question

Я надеюсь, что я использую правильную терминологию.

Я хочу задокументировать публичное мероприятие Action<> делегат

public event Action<int, int, WriteableBitmap, Exception> OperationDone

Для этого я хочу, чтобы пользователь знал, что общего означает для чего. Так что я думал о чем-то вроде:

    /// <summary>
    /// Event triggers if a thumbnail image has been loaded. If loading a thumbnail was requested and the request has failed, 
    /// the causing exception will be passed as argument (otherwise null).
    /// pdfViewerPage, newViewerPage, bitmap, exception
    /// <param name="pdfViewerPage"/> viewer page of the thumbnail at the time of the request creation
    /// <param name="newViewerPage"/> viewer page of the thumbnail at the time of the request completion
    /// <param name="bitmap"/> Bitmap of the thumbnail
    /// <param name="exception"/> Exception of the request
    /// </summary>

Но это дает мне предупреждения, так как делегат не определяет параметры. Есть ли способ красиво документировать это, или я должен придерживаться, чтобы просто использовать summary?

Answer 1

Попробуйте вместо этого использовать typeparam:

/// <typeparam name="pdfViewerPage"> viewer page of the thumbnail at the time of the request creation</typeparam>
/// <typeparam name="newViewerPage"> viewer page of the thumbnail at the time of the request completion</typeparam>
/// <typeparam name="bitmap"> Bitmap of the thumbnail</typeparam>
/// <typeparam name="exception"> Exception of the request</typeparam>