Skip to content

Commit

Permalink
Merge pull request #3855 from bjornhellander/feature/sa1604-doc
Browse files Browse the repository at this point in the history
Corrected SA1604 documentation to include a relevant example
  • Loading branch information
sharwell authored May 30, 2024
2 parents ac00d09 + 6239946 commit b9a30bc
Showing 1 changed file with 2 additions and 4 deletions.
6 changes: 2 additions & 4 deletions documentation/SA1604.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,12 +29,10 @@ A violation of this rule occurs when the element documentation is missing a `<su

To fix a violation of this rule, add and fill-in a `<summary>` tag for the element, containing a description of the element.

The following example shows a class containing invalid Xml within its documentation header. The closing tag for the `<summary>` node is invalid.
The following example shows a class containing a documentation header without a summary.

```csharp
/// <summary>
/// Represents a customer in the database.
/// </summary>
/// <remarks>A remark.</remarks>
public class Customer
{
}
Expand Down

0 comments on commit b9a30bc

Please sign in to comment.