Prefer StringBuilder when building string in a loop

Docs > Plateforme de sécurité Datadog > Code Security > Static Code Analysis (SAST) > Règles SAST > Prefer StringBuilder when building string in a loop

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Metadata

ID: csharp-best-practices/use-stringbuilder

Language: C#

Severity: Info

Category: Best Practices

Description

This rule encourages the use of StringBuilder when constructing strings inside loops instead of using string concatenation. Using + or += to concatenate strings in a loop creates multiple intermediate string instances, which can lead to significant performance overhead due to repeated memory allocation and copying.

Avoiding this pattern is important because strings in C# are immutable, so each concatenation generates a new string object. This can increase memory usage and degrade performance, especially when building large strings or iterating over many elements.

To comply with this rule, use a StringBuilder instance to accumulate string content within loops. For example, instantiate a StringBuilder before the loop, call Append or AppendLine inside the loop to add content, and finally convert it to a string with ToString() after the loop completes.

By following this approach, you write more efficient, readable, and maintainable code that scales better when dealing with dynamic string construction in iterative contexts.

Non-Compliant Code Examples

using System.Collections.Generic;

public class MyController
{
    public string DoSomething(List<Stuff> listOfStuff)
    {
        string html = "";

        for (int i = 0; i < listOfStuff.Count; i++)
        {
            var stuff = listOfStuff[i];
            html += "<div class='product'><h3>" + stuff.Name + "</h3><p>" + stuff.Description + "</p></div>";
            html = html + "<div class='product'><h3>" + stuff.Name + "</h3><p>" + stuff.Description + "</p></div>";
        }

        return html;
    }
}

public class Stuff
{
    public string Name { get; set; }
    public string Description { get; set; }
    public decimal Price { get; set; }
}

public class MyController {
    
    public void DoSomething(Iterable listOfStuff) {
        foreach (var stuff in listOfStuff)
        {
            html += $@"
                <div class='product'>
                    <h3>{stuff.Name}</h3>
                    <p>{stuff.Description}</p>
                    <p>Price: ${stuff.Price}</p>
                </div>";
        }
    }
}

using System.Collections.Generic;

public class MyController
{
    public string DoSomething(List<Stuff> listOfStuff)
    {
        string html = "";

        for (int i = 0; i < listOfStuff.Count; i++)
        {
            var stuff = listOfStuff[i];
            html += $@"
                <div class='product'>
                    <h3>{stuff.Name}</h3>
                    <p>{stuff.Description}</p>
                    <p>Price: ${stuff.Price}</p>
                </div>";
        }

        return html;
    }
}

public class Stuff
{
    public string Name { get; set; }
    public string Description { get; set; }
    public decimal Price { get; set; }
}

Compliant Code Examples

using System.Text;
using System.Collections.Generic;

public class MyController
{
    public string DoSomething(IEnumerable<Stuff> listOfStuff)
    {
        var htmlBuilder = new StringBuilder();

        foreach (var stuff in listOfStuff)
        {
            htmlBuilder.AppendLine($@"
                <div class='product'>
                    <h3>{stuff.Name}</h3>
                    <p>{stuff.Description}</p>
                    <p>Price: ${stuff.Price}</p>
                </div>");
        }

        return htmlBuilder.ToString();
    }
}

public class Stuff
{
    public string Name { get; set; }
    public string Description { get; set; }
    public decimal Price { get; set; }
}