StyleCop C# (Geliştiriciler İçin Nasıl Çalışır)

Örnek 1: Dokümantasyon Yorumlarını Uygulama

StyleCop tarafından uygulanan yaygın bir kural, herkese açık erişilebilir yöntemler ve sınıflar için dokümantasyon yorumları gereğidir. Bu, kodunuzun iyi belgelendiğini ve anlaşılır olmasını sağlar.

// 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;
    }
}

Public Class Calculator
    Public Function Add(a As Integer, b As Integer) As Integer
        Return a + b
    End Function
End Class

StyleCop kullanmadan, kod, Add yönteminin ve a ve b parametrelerinin amacını anlamak için diğer geliştiriciler için zor hale getiren dokümantasyon yorumlarından yoksundur. Bu, kafa karışıklığına ve kod tabanının bakımını azaltmaya neden olabilir.

Kodlama kuralları ihlal edilirse, StyleCop, yukarıdaki Visual Studio ekran görüntüsünde görüldüğü gibi uyarılar verir.

StyleCop Yönergelerini Uygulama

// 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;
    }
}

' 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 Function Add(a As Integer, b As Integer) As Integer
        Return a + b
    End Function
End Class

StyleCop ile kod, Calculator sınıfının ve Add yönteminin işlevselliği hakkında net bilgi sağlayan dokümantasyon yorumları ile eklenir. Geliştiriciler, yöntemin ne yaptığını, hangi parametreleri kabul ettiğini ve ne döndürdüğünü kolayca anlayabilirler, bu da kod okunabilirliğini ve bakımını geliştirir.

Örnek 2: Tutarlı İsimlendirme Kuralları

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

Bu kaynak kodda, sınıf adı (rectangle) ve özellik adları (length, Width) stil ve tutarlılık kurallarını çiğner. Yöntem adları (calculate_area, GetPerimeter) tutarsız biçimlendirme içerir, isimlendirme kurallarında uyarılara neden olur.

Yukarıdaki Kodun Ekran Görüntüsü

StyleCop Kurallarını Uygulamadan Önce

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

Kodun Açıklaması

StyleCop kurallarını uygulamadan önce, kod birkaç ihlal sergiliyor: Metod adı generatePDF PascalCase kuralına uymuyor ve parametre output isimlendirmede netlikten yoksun. Ek olarak, değişken pdf için var ile yapılan örtük tip kullanımı okunabilirliği azaltıyor. HtmlToPdf örneklendirmesi için isim alanını atlamak, özellikle büyük projelerde kafa karışıklığına yol açabilir.

StyleCop Kuralları Uygulandıktan Sonra

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

Kodun Açıklaması

StyleCop kuralları uygulandıktan sonra, metod GeneratePdf PascalCase kuralına uyar ve okunabilirliği artırır. Parametre outputFilePath artık daha açıklayıcı, amacını belirtir. Açık tip kullanımı (ChromePdfRenderer ve PdfDocument) netliği artırır.