-
Notifications
You must be signed in to change notification settings - Fork 1.6k
Summary: Namespace
Genevieve Warren edited this page Oct 20, 2020
·
4 revisions
Namespaces can't be documented in source code /// comments. Instead, add namespace summaries to the ns-<namespace>.xml files in the repo that contains your ECMAXML files. For the dotnet/dotnet-api-docs repo, these files are located in the root XML directory.
The following table provides wording guidelines and boilerplate text for Summary sections in namespace pages.
| Item | Wording | Examples |
|---|---|---|
| Namespace | <Begin with a present-tense, third-person verb, such as Contains or Provides.> |
System.Diagnostics summary: Provides classes that allow you to interact with system processes, event logs, and performance counters. System.Formats.Cbor summary: Contains types used in reading and writing data in the Concise Binary Object Representation (CBOR) format. |