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

Örnek 1: Dökümantasyon Yorumlarını Zorunlu Kılmak

StyleCop tarafından uygulanan ortak bir kural, genel olarak erişilebilir metodlar ve sınıflar için dokümantasyon yorumları gereksinimidir. Bu, kodunuzun iyi belgelenmiş 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 belgeleme yorumları içermez, bu da diğer geliştiricilerin Add metodunun amacını ve a ve b parametrelerini anlamasını zorlaştırır. Bu, karışıklığa ve kod tabanının bakım kolaylığının azalmasına neden olabilir.

Kodlama kuralları ihlal edilirse, StyleCop Visual Studio içindeki yukarıdaki ekranda görüldüğü gibi uyarılar verir.

StyleCop Kurallarinin Uygulanmasi

// 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, kodunuza dokümantasyon yorumları eklenir, Calculator sınıfının ve onun Add metodunun işlevi hakkında net bilgi sağlanır. Geliştiriciler, metodun ne yaptığını, hangi parametreleri kabul ettiğini ve neyi iade ettiğini kolayca anlar, bu da kod okunabilirliğini ve bakım kolaylığını artırır.

Ö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 kodunda, sınıf adı (rectangle) ve özellik adları (length, Width) stil ve tutarlılık kurallarını ihlal eder. Metod adları (calculate_area, GetPerimeter) tutarsız büyük-küçük harf kullanımı nedeniyle isimlendirme standardı uyarıları verir.

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

StyleCop Kuralları Uygulanmadan Ö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, kodda birkaç ihlal gözlemlenir: generatePDF yöntem adı PascalCase kuralına uymuyor ve output parametresi net bir isimlendirmeye sahip değil. Ayrıca, var ile pdf değişkenine yönelik örtük tip kullanımı okunabilirliği azaltır. HtmlToPdf örneklemesi için isim alanının atlanması özellikle büyük projelerde karışıklığa yol açabilir.

StyleCop Kurallari Uygulandiktan 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, GeneratePdf yöntemi PascalCase kuralına uyarak okunabilirliği artırır. outputFilePath parametresi artık daha açıklayıcı olup, amacını belirtmektedir. Açık tip kullanımı (ChromePdfRenderer ve PdfDocument) netliği artırır.