StyleCop C# (Comment ça fonctionne pour les développeurs)

Exemple 1 : Application des commentaires de documentation

Une règle commune appliquée par StyleCop est l'exigence de commentaires de documentation sur les méthodes et classes accessibles au public. Cela garantit que votre code est bien documenté et compréhensible.

// Source code without StyleCop
public class Calculator
{
    public int Add(int a, int b)
    {
        return a + b;
    }
}

// Source code without StyleCop
public class Calculator
{
    public int Add(int a, int b)
    {
        return a + b;
    }
}

IRON VB CONVERTER ERROR developers@ironsoftware.com

Sans utiliser StyleCop, le code manque de commentaires de documentation, ce qui rend difficile pour d'autres développeurs de comprendre le but de la méthode Add et des paramètres a et b. Cela peut entraîner de la confusion et une diminution de la maintenabilité de la base de code.

Si les conventions de codage sont violées, StyleCop émet des avertissements, comme le montre la capture d'écran ci-dessus dans Visual Studio.

Mise en œuvre des lignes directrices de StyleCop

// Code with StyleCop
/// <summary>
/// Provides methods for basic arithmetic operations.
/// </summary>
public class Calculator
{
    /// <summary>
    /// Adds two integers.
    /// </summary>
    /// <param name="a">The first integer.</param>
    /// <param name="b">The second integer.</param>
    /// <returns>The sum of the two integers.</returns>
    public int Add(int a, int b)
    {
        return a + b;
    }
}

// Code with StyleCop
/// <summary>
/// Provides methods for basic arithmetic operations.
/// </summary>
public class Calculator
{
    /// <summary>
    /// Adds two integers.
    /// </summary>
    /// <param name="a">The first integer.</param>
    /// <param name="b">The second integer.</param>
    /// <returns>The sum of the two integers.</returns>
    public int Add(int a, int b)
    {
        return a + b;
    }
}

IRON VB CONVERTER ERROR developers@ironsoftware.com

Avec StyleCop, des commentaires de documentation sont ajoutés au code, fournissant des informations claires sur la fonctionnalité de la classe Calculator et de sa méthode Add. Les développeurs peuvent facilement comprendre ce que fait la méthode, quels paramètres elle accepte et ce qu'elle retourne, améliorant ainsi la lisibilité et la maintenabilité du code.

Exemple 2 : Conventions de dénomination cohérentes

public class rectangle
{
    public double length;
    public double Width;

    public void calculate_area()
    {
        // Calculate area
    }

    public void GetPerimeter()
    {
        // Calculate perimeter
    }
}

public class rectangle
{
    public double length;
    public double Width;

    public void calculate_area()
    {
        // Calculate area
    }

    public void GetPerimeter()
    {
        // Calculate perimeter
    }
}

Public Class rectangle
	Public length As Double
	Public Width As Double

	Public Sub calculate_area()
		' Calculate area
	End Sub

	Public Sub GetPerimeter()
		' Calculate perimeter
	End Sub
End Class

Dans ce code source, le nom de la classe (rectangle) et les noms des propriétés (length, Width) violent les règles de style et de cohérence. Les noms des méthodes (calculate_area, GetPerimeter) présentent une casse incohérente, entraînant des avertissements de convention de dénomination.

Capture d'écran du code ci-dessus

Avant l'application des règles de StyleCop

using IronPdf;

namespace YourNamespace
{
    public class PdfGenerator
    {
        public void generatePDF(string output)
        {
            // This code snippet does not adhere to StyleCop rules
            var renderer = new ChromePdfRenderer();
            PdfDocument pdf = renderer.RenderUrlAsPdf("<h1>Hello, World!</h1>");
            pdf.SaveAs(output);
        }
    }
}

using IronPdf;

namespace YourNamespace
{
    public class PdfGenerator
    {
        public void generatePDF(string output)
        {
            // This code snippet does not adhere to StyleCop rules
            var renderer = new ChromePdfRenderer();
            PdfDocument pdf = renderer.RenderUrlAsPdf("<h1>Hello, World!</h1>");
            pdf.SaveAs(output);
        }
    }
}

Imports IronPdf

Namespace YourNamespace
	Public Class PdfGenerator
		Public Sub generatePDF(ByVal output As String)
			' This code snippet does not adhere to StyleCop rules
			Dim renderer = New ChromePdfRenderer()
			Dim pdf As PdfDocument = renderer.RenderUrlAsPdf("<h1>Hello, World!</h1>")
			pdf.SaveAs(output)
		End Sub
	End Class
End Namespace

Description du code

Avant l'application des règles de StyleCop, le code présente plusieurs violations : le nom de la méthode generatePDF ne respecte pas la convention PascalCase, et le paramètre output manque de clarté dans la dénomination. De plus, le typage implicite avec var pour la variable pdf réduit la lisibilité. Omettre le namespace pour l'instanciation de HtmlToPdf peut prêter à confusion, surtout dans des projets plus vastes.

Après l'application des règles de StyleCop

using IronPdf;

namespace YourNamespace
{
    /// <summary>
    /// Provides PDF generation functionalities.
    /// </summary>
    public class PdfGenerator
    {
        /// <summary>
        /// Generates a PDF from a URL and saves it to the specified file path.
        /// </summary>
        /// <param name="outputFilePath">The file path where the PDF will be saved.</param>
        public void GeneratePdf(string outputFilePath)
        {
            // This code snippet adheres to StyleCop rules
            ChromePdfRenderer chromePdfRenderer = new ChromePdfRenderer();
            PdfDocument pdfDocument = chromePdfRenderer.RenderUrlAsPdf("<h1>Hello, World!</h1>");
            pdfDocument.SaveAs(outputFilePath);
        }
    }
}

using IronPdf;

namespace YourNamespace
{
    /// <summary>
    /// Provides PDF generation functionalities.
    /// </summary>
    public class PdfGenerator
    {
        /// <summary>
        /// Generates a PDF from a URL and saves it to the specified file path.
        /// </summary>
        /// <param name="outputFilePath">The file path where the PDF will be saved.</param>
        public void GeneratePdf(string outputFilePath)
        {
            // This code snippet adheres to StyleCop rules
            ChromePdfRenderer chromePdfRenderer = new ChromePdfRenderer();
            PdfDocument pdfDocument = chromePdfRenderer.RenderUrlAsPdf("<h1>Hello, World!</h1>");
            pdfDocument.SaveAs(outputFilePath);
        }
    }
}

Imports IronPdf

Namespace YourNamespace
	''' <summary>
	''' Provides PDF generation functionalities.
	''' </summary>
	Public Class PdfGenerator
		''' <summary>
		''' Generates a PDF from a URL and saves it to the specified file path.
		''' </summary>
		''' <param name="outputFilePath">The file path where the PDF will be saved.</param>
		Public Sub GeneratePdf(ByVal outputFilePath As String)
			' This code snippet adheres to StyleCop rules
			Dim chromePdfRenderer As New ChromePdfRenderer()
			Dim pdfDocument As PdfDocument = chromePdfRenderer.RenderUrlAsPdf("<h1>Hello, World!</h1>")
			pdfDocument.SaveAs(outputFilePath)
		End Sub
	End Class
End Namespace

Description du code

Après avoir appliqué les règles de StyleCop, la méthode GeneratePdf suit la convention PascalCase, améliorant la lisibilité. Le paramètre outputFilePath est désormais plus descriptif, indiquant sa finalité. L'utilisation du typage explicite (ChromePdfRenderer et PdfDocument) améliore la clarté.