C# 中逐字字符串的多行格式（前缀为 @）

Question

我喜欢在 C# 中使用 @"strings"，尤其是当我有很多多行文本时。唯一的烦恼是，在执行此操作时，我的代码格式会变得很糟糕，因为第二行和更多行被完全推到左侧，而不是使用我格式精美的代码的缩进。我知道这是设计使然，但是是否有一些选项/黑客方法可以允许这些行缩进，而不在输出中添加实际的制表符/空格？

添加示例：

        var MyString = @" this is 
a multi-line string
in c#.";

我的变量声明缩进到“正确”的深度，但是字符串中的第二行和更多行被推到左边距 - 所以代码有点难看。您可以将制表符添加到第 2 行和第 3 行的开头，但字符串本身将包含这些制表符...有意义吗？

Answer 1

字符串扩展怎么样？更新：我重新阅读了您的问题，希望有更好的答案。这也是让我烦恼的事情，必须按如下方式解决它是令人沮丧的，但从好的方面来说它确实有效。

using System.Text.RegularExpressions;

namespace ConsoleApplication1
{
    public static class StringExtensions
    {
        public static string StripLeadingWhitespace(this string s)
        {
            Regex r = new Regex(@"^\s+", RegexOptions.Multiline);
            return r.Replace(s, string.Empty);
        }
    }
}

以及一个示例控制台程序：

using System;

namespace ConsoleApplication1
{
    class Program
    {
        static void Main(string[] args)
        {
            string x = @"This is a test
                of the emergency
                broadcasting system.";

            Console.WriteLine(x);

            Console.WriteLine();
            Console.WriteLine("---");
            Console.WriteLine();

            Console.WriteLine(x.StripLeadingWhitespace());

            Console.ReadKey();
        }
    }
}

以及输出：

This is a test
                of the emergency
                broadcasting system.

---

This is a test
of the emergency
broadcasting system.

如果您决定走这条路线，那么还有一种更简洁的使用方式：

string x = @"This is a test
    of the emergency
    broadcasting system.".StripLeadingWhitespace();
// consider renaming extension to say TrimIndent() or similar if used this way

Answer 2

Cymen给出了正确的解决方案。我使用源自 Scala 的 stripMargin() 方法的类似方法。我的扩展方法如下所示：

public static string StripMargin(this string s)
{
    return Regex.Replace(s, @"[ \t]+\|", string.Empty);
}

用法：

var mystring = @"
        |SELECT 
        |    *
        |FROM
        |    SomeTable
        |WHERE
        |    SomeColumn IS NOT NULL"
    .StripMargin();

结果：

SELECT 
    *
FROM
    SomeTable
WHERE
    SomeColumn IS NOT NULL

Answer 3

对于 C# 11，您现在可以使用 原始字符串文字。

var MyString = """
    this is 
    a multi-line string
    in c#.
    """;

输出是：

this is
a multi-line string
in c#.

它还与字符串插值结合：

var variable = 24.3;
var myString = $"""
    this is 
    a multi-line string
    in c# with a {variable}.
    """;

Answer 4

我想不出完全满足您问题的答案，但是您可以编写一个函数，从字符串中包含的文本行中去除前导空格，并在每次创建此类字符串时调用它。

var myString = TrimLeadingSpacesOfLines(@" this is a 
    a multi-line string
    in c#.");

是的，这是一个黑客攻击，但您在问题中指定了接受黑客攻击。

Answer 5

这是一个较长的解决方案，它试图尽可能地模仿 textwrap.dedent 。第一行保持原样，预计不会缩进。 （您可以使用 doctest-csharp 基于 doctest 生成单元测试。）

/// <summary>
/// Imitates the Python's
/// <a href="https://docs.python.org/3/library/textwrap.html#textwrap.dedent">
/// <c>textwrap.dedent</c></a>.
/// </summary>
/// <param name="text">Text to be dedented</param>
/// <returns>array of dedented lines</returns>
/// <code doctest="true">
/// Assert.That(Dedent(""), Is.EquivalentTo(new[] {""}));
/// Assert.That(Dedent("test me"), Is.EquivalentTo(new[] {"test me"}));
/// Assert.That(Dedent("test\nme"), Is.EquivalentTo(new[] {"test", "me"}));
/// Assert.That(Dedent("test\n  me"), Is.EquivalentTo(new[] {"test", "  me"}));
/// Assert.That(Dedent("test\n  me\n    again"), Is.EquivalentTo(new[] {"test", "me", "  again"}));
/// Assert.That(Dedent("  test\n  me\n    again"), Is.EquivalentTo(new[] {"  test", "me", "  again"}));
/// </code>
private static string[] Dedent(string text)
{
    var lines = text.Split(
        new[] {"\r\n", "\r", "\n"},
        StringSplitOptions.None);

    // Search for the first non-empty line starting from the second line.
    // The first line is not expected to be indented.
    var firstNonemptyLine = -1;
    for (var i = 1; i < lines.Length; i++)
    {
        if (lines[i].Length == 0) continue;

        firstNonemptyLine = i;
        break;
    }

    if (firstNonemptyLine < 0) return lines;

    // Search for the second non-empty line.
    // If there is no second non-empty line, we can return immediately as we
    // can not pin the indent.
    var secondNonemptyLine = -1;
    for (var i = firstNonemptyLine + 1; i < lines.Length; i++)
    {
        if (lines[i].Length == 0) continue;

        secondNonemptyLine = i;
        break;
    }

    if (secondNonemptyLine < 0) return lines;

    // Match the common prefix with at least two non-empty lines
    
    var firstNonemptyLineLength = lines[firstNonemptyLine].Length;
    var prefixLength = 0;
    
    for (int column = 0; column < firstNonemptyLineLength; column++)
    {
        char c = lines[firstNonemptyLine][column];
        if (c != ' ' && c != '\t') break;
        
        bool matched = true;
        for (int lineIdx = firstNonemptyLine + 1; lineIdx < lines.Length; 
                lineIdx++)
        {
            if (lines[lineIdx].Length == 0) continue;
            
            if (lines[lineIdx].Length < column + 1)
            {
                matched = false;
                break;
            }

            if (lines[lineIdx][column] != c)
            {
                matched = false;
                break;
            }
        }

        if (!matched) break;
        
        prefixLength++;
    }

    if (prefixLength == 0) return lines;
    
    for (var i = 1; i < lines.Length; i++)
    {
        if (lines[i].Length > 0) lines[i] = lines[i].Substring(prefixLength);
    }

    return lines;
}