Avoid short method names

Docs > Code Analysis > Static Analysis Rules > Avoid short method names

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Metadata

ID: csharp-code-style/short-method-name

Language: C#

Severity: Notice

Category: Code Style

Description

Method names should be descriptive of the function behavior and functionalities. Instead of using a very short name, always have a name that indicates what the function is doing.

Learn More

C# Google Style Guide

Non-Compliant Code Examples

class MyClass {
    void ab(){
        
    }
}

interface MyInterface {
    void ab();
}

Compliant Code Examples

interface MyInterface {
    void myMethod();
}

class MyClass {
    void myMethod(){
        
    }
}

How to use this rule

1
2
rulesets:
  - csharp-code-style     # Rules to enforce C# code style.

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