Skip to content

Commit 400f970

Browse files
committed
updated documentation
1 parent 29514d2 commit 400f970

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

documentation/SA1642.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,23 @@ private Customer()
9696
}
9797
```
9898

99+
The `<para>` tag can be used within the `<summary>` tag to structure the text.
100+
For example:
101+
102+
```csharp
103+
/// <summary>
104+
/// <para>
105+
/// Initializes a new instance of the <see cref="Customer"/> class.
106+
/// </para>
107+
/// <para>
108+
/// Additional information can be included in subsequent paragraphs.
109+
/// </para>
110+
/// </summary>
111+
public Customer()
112+
{
113+
}
114+
```
115+
99116
## How to fix violations
100117

101118
To fix a violation of this rule, edit the summary text for the constructor as described above.

0 commit comments

Comments
 (0)