The introductory context is an optional lead sentence tells the reader enough about the page to help them know whether to read on. For example, tell what feature or function this reference is for. The sections you include in your reference page will vary widely. The shown sections are merely suggestions.
Offer the details a user needs to know about the definition, parameters, and so on. Tables are extremely useful for looking up information and organizing the details that readers want to know.
The section below describes how to use the feature from a programming language. Remove the section if not appropriate. Depending on the programming language used, you may be able to use syntax highlighting.
void print(String message)
The section below describes how the feature is parameterized. Remove the section if not appropriate.
Message to print.
The section below describes the response value of an invocation. Remove the section if not appropriate.
Upon successful invocation, this feature returns ...
The section below lists the exceptions that this feature can throw. Remove the section if not appropriate.
| Exception | Condition |
|---|---|
| ArgumentNullException | message is null. |
The section below is for remarks about security, special scenarios or edge cases, and so on. Remove the section if not appropriate.
Additional points to consider are ...
The example sections show common usages of the feature as they would occur for the reader. Depending on the programming language used, you may be able to use syntax highlighting. Remove the section if not appropriate.
First example shows ...
Second example shows ...
The section below describes system or version requirements for using this reference information or context. You can also tell the user when not to use this parameter or programming interface.
Give some considerations such as system requirements or "gotchas" for this setting or control or programming syntax.