StyleCop C#（開發者使用指南）

範例 1：強制執行文件註釋

StyleCop 強制執行的一條常見規則是，要求對公開可存取的方法和類別添加文件註解。 這樣可以確保你的程式碼文件齊全且易於理解。

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

不使用 StyleCop，程式碼缺少文件註釋，使得其他開發人員難以理解Add方法及其參數a和b的用途。 這會導致程式碼庫混亂並降低其可維護性。

StyleCop C#（開發者使用指南）：圖 4 - 文件警告

如果違反編碼規範，StyleCop 會發出警告，如上圖 Visual Studio 中的螢幕截圖所示。

實施 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;
    }
}

使用 StyleCop，可以在程式碼中新增文件註釋，提供有關Calculator類別及其Add方法的功能的清晰資訊。 開發人員可以輕鬆了解該方法的功能、接受的參數以及返回值，從而提高程式碼的可讀性和可維護性。

範例 2：一致的命名規則

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

這段原始碼中，類別名稱（ rectangle ）和屬性名稱（ length 、 Width ）違反了樣式和一致性規則。 方法名稱（ calculate_area 、 GetPerimeter ）大小寫不一致，導致命名約定警告。

以上程式碼的螢幕截圖

StyleCop C#（開發者使用指南）：圖 5 - 命名約定

在強制執行 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);
        }
    }
}

代碼描述

在強制執行 StyleCop 規則之前，程式碼有幾個違規行為：方法名稱generatePDF不符合 PascalCase 約定，參數output命名不夠清晰。 此外，使用var對變數pdf進行隱含型別會降低可讀性。 省略HtmlToPdf實例化的命名空間可能會導致混淆，尤其是在大型專案中。

強制執行 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);
        }
    }
}

代碼描述

在應用 StyleCop 規則後， GeneratePdf方法遵循 PascalCase 命名約定，提高了可讀性。 參數outputFilePath現在更具描述性，表明了其用途。 使用顯式類型（ ChromePdfRenderer和PdfDocument ）可以提高清晰度。