我希望我使用的是正确的术语。
我想记录一个公共(public)事件 Action<> delegate
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>
但这给了我警告,因为委托(delegate)没有定义参数。有没有办法很好地记录这个,还是我必须坚持只使用 summary
?
最佳答案
尝试使用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>
关于c# - 正确记录 C# 事件委托(delegate),我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/40154396/