Is there a standard/common practice for documenting an event handler? [closed]

Closed. This question is opinion-based. It is not currently accepting answers.

---

Want to improve this question? Update the question so it can be开发者_C百科 answered with facts and citations by editing this post.

Closed 5 years ago.

Improve this question

This is something that causes me some pause from time to time. It seems like I need to provide a description for sender and e. Since I cannot think of anything particularly meaningful I'd prefer to delete the two param elements.

    /// <summary>
    /// Fired when the destination project is updated.
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="e"></param>
    private void UpdateDestinations(object sender, EventArgs e)

---

You might want to use GhostDoc to do all the heavy lifting for you (like the parameters documentation for example) so that you can concentrate on providing meaningful information for the remaining elements (the summary in that case).