Exceptions should be made public

Documentos > Code Analysis > Static Analysis Rules > Exceptions should be made public

This page is not yet available in Spanish. We are working on its translation.
If you have any questions or feedback about our current translation project, feel free to reach out to us!

Metadata

ID: csharp-best-practices/exceptions-public

Language: C#

Severity: Warning

Category: Best Practices

Description

Exceptions should not be made internal and should be made public. Exceptions are designed to be reused across the codebase or in multiple codebases. By making an exception internal, it then cannot be reused across the different codebases.

Non-Compliant Code Examples

internal class MyCustomException: Exception {
    
}

Compliant Code Examples

public class MyCustomException: Exception {
    
}

How to use this rule

1
2
rulesets:
  - csharp-best-practices     # Rules to enforce C# best practices.

Create a static-analysis.datadog.yml with the content above at the root of your repository
Use our free IDE Plugins or add Code Analysis scans to your CI pipelines
Get feedback on your code

For more information, please read the Code Analysis documentation

VS Code Extension

Identify code vulnerabilities directly in your
VS Code editor

JetBrains Plugin

Identify code vulnerabilities directly in
JetBrains products