Skip to content

Update SA1600 to show inheritance example. #3385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Feb 8, 2022
Merged

Update SA1600 to show inheritance example. #3385

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5403239
Update SA1600 to show inheritance example.
codajo Sep 20, 2021
b54862d
Apply suggestions from code review
sharwell Sep 21, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions documentation/SA1600.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,36 @@ public string JoinNames(string firstName, string lastName)
}
```

The next example shows a method that inherits documentation from a method in the base class:

```csharp
/// <summary>
/// Example base class.
/// </summary>
class Vehicle
{
/// <summary>
/// Accelerates the vehicle.
/// </summary>
public virtual void Accelerate()
{
Console.WriteLine("Vehicle is accelerating");
}
}

/// <summary>
/// Example derived class.
/// </summary>
class Car : Vehicle
{
/// <inheritdoc/>
public override void Accelerate()
{
Console.Writeline("Car is accelerating");
}
}
```

## How to suppress violations

```csharp
Expand Down