Skip to content

Summary: Method

Jump to bottom
Genevieve Warren edited this page Oct 3, 2023 · 5 revisions

The following table provides wording guidelines and boilerplate text for Summary sections in method pages. For guidelines about On<Event> methods, see the Event-related section. For guidelines about documenting overloaded methods, see Overloaded member.

ItemWordingExamples
General method<Begin with a present-tense third-person verb.>Application.DoEventsmethod summary:
Processes Windows messages that are currently in the message queue.
Task-returning or async methodAsynchronously <present-tense third-person verb> <XXX>.HttpClient.GetStringAsyncmethod summary:
Asynchronously sends a GET request to the specified Uri.
Dispose method, general overloadReleases the resources used by the current instance of the <class> class.ComponentDesigner.Disposemethod summary:
Releases the resources used by the current instance of the ComponentDesigner class.
Dispose() methodReleases the resources used by the current instance of the <class> class.Timer.Disposemethod summary:
Releases the resources used by the current instance of the Timer class.
Dispose(Boolean) methodCalled by the Dispose() and Finalize() methods to release the managed and unmanaged resources used by the current instance of the <class> class.DocumentDesigner.Disposemethod (Boolean):
Called by the Dispose() and Finalize() methods to release the managed and unmanaged resources used by the current instance of the DocumentDesigner class.
ShouldSerialize<Property> methodIndicates whether the <Property> property should be persisted.DataGrid.ShouldSerializeBackgroundColormethod summary:
Indicates whether the BackgroundColor property should be persisted.
Reset<Property> methodResets the <Property> property to its default value.Control.ResetTextmethod summary:
Resets the Text property to its default value.
Method that always throws an exceptionThrows a/an <ExceptionType> exception in all cases.

Note:
In the Remarks section, explain why the member is not supported.		DataGridViewSelectedRowCollection.Clearmethod summary:
Throws a NotSupportedException exception in all cases.
Explicit interface method implementation<Copy from the interface member if appropriate>

Home

Clone this wiki locally