Skip to content

Allow MA0196 inheritdoc on constructors matching base signatures#1149

Merged
meziantou merged 1 commit into
mainfrom
meziantou/ma0196-base-option
May 12, 2026
Merged

Allow MA0196 inheritdoc on constructors matching base signatures#1149
meziantou merged 1 commit into
mainfrom
meziantou/ma0196-base-option

Conversation

@meziantou

@meziantou meziantou commented May 12, 2026

Copy link
Copy Markdown
Owner

MA0196 was reporting <inheritdoc /> on constructors even in cases where constructor documentation is effectively inherited from a base constructor with the same signature. This created noise compared to the behavior users see in Visual Studio.

This change updates MA0196 to treat constructors as inheriting members when their signature matches a constructor on the base type.

What changed

  • Updated InheritdocShouldBeUsedOnInheritingMemberAnalyzer to allow constructor <inheritdoc /> when a base constructor has the same signature.
  • Signature matching is semantic and checks parameter count, parameter types, ref kind, and params shape.
  • Kept diagnostics for constructors that do not match any base constructor signature.
  • Added test coverage for matching and non-matching constructor signatures, including parameterless constructors.
  • Updated docs/Rules/MA0196.md to document the constructor behavior and include an example.

Validation

  • Ran targeted MA0196 analyzer tests on default Roslyn and on roslyn4.2 and roslyn4.14.
  • Regenerated documentation with dotnet run --project src/DocumentationGenerator.

Fix #1145

Treat constructors as inheriting members when their signature matches a base constructor signature, and keep reporting when there is no match. Update MA0196 tests and documentation accordingly.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@meziantou meziantou enabled auto-merge (squash) May 12, 2026 03:36
@meziantou meziantou merged commit 888c826 into main May 12, 2026
13 checks passed
@meziantou meziantou deleted the meziantou/ma0196-base-option branch May 12, 2026 05:29
IhateTrains pushed a commit to ParadoxGameConverters/ImperatorToCK3 that referenced this pull request May 12, 2026
Updated
[Meziantou.Analyzer](https://github.com/meziantou/Meziantou.Analyzer)
from 3.0.77 to 3.0.79.

<details>
<summary>Release notes</summary>

_Sourced from [Meziantou.Analyzer's
releases](https://github.com/meziantou/Meziantou.Analyzer/releases)._

## 3.0.79

NuGet package:
<https://www.nuget.org/packages/Meziantou.Analyzer/3.0.79>

## What's Changed
* Document comparison page maintenance expectations by @​meziantou in
meziantou/Meziantou.Analyzer#1146
* Allow MA0196 inheritdoc on constructors matching base signatures by
@​meziantou in meziantou/Meziantou.Analyzer#1149
* Add annotation-based exclusions for MA0042 and MA0045 by @​meziantou
in meziantou/Meziantou.Analyzer#1148


**Full Changelog**:
meziantou/Meziantou.Analyzer@3.0.78...3.0.79

## 3.0.78

NuGet package:
<https://www.nuget.org/packages/Meziantou.Analyzer/3.0.78>

## What's Changed
* Optimize analyzer hot paths and metadata lookups by @​meziantou in
meziantou/Meziantou.Analyzer#1144


**Full Changelog**:
meziantou/Meziantou.Analyzer@3.0.77...3.0.78

Commits viewable in [compare
view](meziantou/Meziantou.Analyzer@3.0.77...3.0.79).
</details>

[![Dependabot compatibility
score](https://dependabot-badges.githubapp.com/badges/compatibility_score?dependency-name=Meziantou.Analyzer&package-manager=nuget&previous-version=3.0.77&new-version=3.0.79)](https://docs.github.com/en/github/managing-security-vulnerabilities/about-dependabot-security-updates#about-compatibility-scores)

Dependabot will resolve any conflicts with this PR as long as you don't
alter it yourself. You can also trigger a rebase manually by commenting
`@dependabot rebase`.

[//]: # (dependabot-automerge-start)
[//]: # (dependabot-automerge-end)

---

<details>
<summary>Dependabot commands and options</summary>
<br />

You can trigger Dependabot actions by commenting on this PR:
- `@dependabot rebase` will rebase this PR
- `@dependabot recreate` will recreate this PR, overwriting any edits
that have been made to it
- `@dependabot show <dependency name> ignore conditions` will show all
of the ignore conditions of the specified dependency
- `@dependabot ignore this major version` will close this PR and stop
Dependabot creating any more for this major version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this minor version` will close this PR and stop
Dependabot creating any more for this minor version (unless you reopen
the PR or upgrade to it yourself)
- `@dependabot ignore this dependency` will close this PR and stop
Dependabot creating any more for this dependency (unless you reopen the
PR or upgrade to it yourself)


</details>

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
This was referenced May 12, 2026
This was referenced Jun 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Inheritdoc on constructor raises MA0196

1 participant