StyleCop C# (jak to działa dla programistów)

Przykład 1: Egzekwowanie komentarzy w dokumentacji

Jedną z powszechnych zasad egzekwowanych przez StyleCop jest wymóg umieszczania komentarzy dokumentacyjnych w metodach i klasach dostępnych publicznie. Dzięki temu kod będzie dobrze udokumentowany i zrozumiały.

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

Bez użycia StyleCop w kodzie brakuje komentarzy dokumentacyjnych, co utrudnia innym programistom zrozumienie celu metody Add oraz parametrów a i b. Może to prowadzić do niejasności i pogorszenia łatwości utrzymania kodu.

W przypadku naruszenia konwencji kodowania StyleCop wyświetla ostrzeżenia, jak widać na powyższym zrzucie ekranu z programu Visual Studio.

Wdrażanie wytycznych 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;
    }
}

' 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

Dzięki StyleCop do kodu dodawane są komentarze dokumentacyjne, które dostarczają jasnych informacji na temat funkcjonalności klasy Calculator i jej metody Add. Programiści mogą łatwo zrozumieć, co robi dana metoda, jakie parametry przyjmuje i co zwraca, co poprawia czytelność i łatwość utrzymania kodu.

Przykład 2: Spójne konwencje nazewnictwa

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

W tym kodzie źródłowym nazwa klasy (rectangle) oraz nazwy właściwości (length, Width) naruszają zasady stylu i spójności. Nazwy metod (calculate_area, GetPerimeter) mają niejednolity styl pisowni, co powoduje ostrzeżenia dotyczące konwencji nazewnictwa.

Zrzut ekranu powyższego kodu

Przed zastosowaniem reguł 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

Opis kodu

Przed zastosowaniem reguł StyleCop kod wykazuje kilka naruszeń: nazwa metody generatePDF nie jest zgodna z konwencją PascalCase, a nazwa parametru output jest niejasna. Ponadto domyślne typowanie za pomocą var dla zmiennej pdf zmniejsza czytelność. Pominięcie przestrzeni nazw dla instancji HtmlToPdf może prowadzić do niejasności, zwłaszcza w większych projektach.

Po zastosowaniu reguł 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

Opis kodu

Po zastosowaniu reguł StyleCop metoda GeneratePdf jest zgodna z konwencją PascalCase, co poprawia czytelność. Parametr outputFilePath jest teraz bardziej opisowy i wskazuje na swój cel. Zastosowanie wyraźnego typowania (ChromePdfRenderer i PdfDocument) zwiększa przejrzystość.