Summary on async (void) Method: What to return?

Question

This is maybe a trivial question but currently im doing some Inline-Documentation for future Coworkers and stumbled upon something like that:

/// <summary> /// This Class is totaly useless /// </summary> public class DummyClass {    /// <summary>   /// Will do nothing   /// </summary>   public void DoNothing() {   }    /// <summary>   /// Will do nothing async   /// </summary>   /// <returns></returns> <---- What to write here?   public async Task DoNothingAsync() {     await Task.Run(() => { });   }  } 

As you might know, typing 3 slashes above an Method/Field/Class/whatever, triggers VisualStudio to perform its Summary-Snippet-Completion.

Question

Is Task actually a valid return-value? And if so, what do i write in the <returns></returns>?

I surely do know, i can ignore this, but for the sake of completeness im willing to write stuff there.

Answer 1

If we take inspiration from API's that Microsoft have produced recently, you might just state:

<returns>No object or value is returned by this method when it completes.</returns> 

I dislike "A task object that can be awaited" for the same reason I wouldn't decorate a method that returns an int with "an integer which can be compared to zero or used in mathematical operations" - it doesn't describe the return value of the method, it describes the type. The type has its own documentation which can be consulted.