在 C# 中声明一个冗长的单行字符串

Question

是否有一种在 C# 中声明长单行字符串的好方法，这样就可以在编辑器中声明和/或查看该字符串了？

我知道的选项是：

1：让它运行。这很糟糕，因为你的字符串远远超出了屏幕的右侧，使得阅读消息的开发人员不得不烦人地滚动和阅读。

string s = "this is my really long string.  this is my really long string.  this is my really long string.  this is my really long string.  this is my really long string.  this is my really long string.  this is my really long string.  this is my really long string.  ";

2：@+换行符。这在代码中看起来不错，但会在字符串中引入换行符。此外，如果你希望它在代码中看起来不错，你不仅会得到换行符，而且还会在字符串的每一行的开头得到尴尬的空格。

string s = @"this is my really long string.  this is my long string.
             this line will be indented way too much in the UI. 
This line looks silly in code.  All of them suffer from newlines in the UI.";

3： "" + ... 这工作正常，但输入起来非常令人沮丧。如果我需要在某处添加半行文本，我必须更新各种 + 并四处移动文本。

string s = "this is my really long string.  this is my long string. " + 
           "this will actually show up properly in the UI and looks " +
           "pretty good in the editor, but is just a pain to type out " +
           "and maintain";

4：string.format 或 string.concat。与上面基本相同，但没有加号。具有相同的优点和缺点。

难道真的没有办法做好这件事吗？

Answer 1

就我个人而言，我会从文件（也许是 XML 文档）中读取这么大的字符串。

Answer 2

你可以使用 StringBuilder

Answer 3

对于很长的字符串，我会将其存储在 XML（或资源）中。对于在代码中使用它有意义的情况，我使用带有 + 运算符的多行字符串连接。不过，我唯一能想到的地方是在读取和解析 XML 的代码的单元测试中，我实际上试图避免使用 XML 文件进行测试。由于这是一个单元测试，我几乎总是希望有该字符串可供参考。在这些情况下，我可能会将它们全部隔离到 #region 指令中，以便我可以根据需要显示/隐藏它。

Answer 4

我要么让它运行，要么使用 string.format 并将字符串写在一行中（让它运行方法），但将每个参数放在新行中，这使得它更容易阅读，或者至少给读者无需详细阅读，就知道他可以在长字符串中期待什么。

Answer 5

使用 Visual Studio 顶部菜单中的Project / Properties / Settings。使范围=“应用程序”。

在“值”框中，您可以输入很长的字符串，并且作为奖励，换行符会被保留。然后您的代码可以像这样引用该字符串：

string sql = Properties.Settings.Default.xxxxxxxxxxxxx;

Answer 6

有一个办法。将很长的字符串放入资源中。您甚至可以在那里放置长文本，因为这是文本应该放置的位置。直接将它们放在代码中是一种非常糟糕的做法。

Answer 7

如果您确实想要在代码中使用这个长字符串，并且您确实不想键入 end-quote-plus-begin-quote，那么您可以尝试这样的操作。

string longString = @"Some long string, 
    with multiple whitespace characters 
    (including newlines and carriage returns)
    converted to a single space
    by a regular expression replace.";

longString = Regex.Replace(longString, @"\s+", " ");

Answer 8

如果使用 Visual Studio，

Tools > Options > Text Editor > All Languages > Word Wrap

我确信任何其他文本编辑器（包括记事本）都能够做到这一点！

Answer 9

这取决于字符串最终将如何使用。这里的所有答案都是有效的，但上下文很重要。如果要记录长字符串“s”，则应该用日志保护测试包围它，例如这个 Log4net 示例：

if (log.IsDebug) {
    string s = "blah blah blah" + 
    // whatever concatenation you think looks the best can be used here,
    // since it's guarded...
}

如果要向用户显示长字符串 s，则Developer Art 的答案是最好的选择...那些应该在资源文件中。

对于其他用途（生成 SQL 查询字符串、写入文件[但要再次考虑这些资源]等），您要连接的不仅仅是文字，请考虑 StringBuilder，如 Wael Dalloul 建议的那样，特别是如果您的字符串可能最终出现在一个函数中，而该函数可能在遥远的将来的某个日期在时间关键的应用程序中被多次调用（所有这些调用加起来）。例如，在构建 SQL 查询时，我会执行此操作，其中参数是变量。

除此之外，不，我不知道有什么东西既看起来漂亮又易于输入（尽管自动换行建议是个好主意，但它可能无法很好地转换为 diff 工具、代码打印输出或代码审查工具） ）。这些就是休息时间。 （我个人使用加号方法使换行整齐，以便打印输出和代码审查）。

Answer 10

您可以像这样使用 StringBuilder：

StringBuilder str = new StringBuilder();
str.Append("this is my really long string.  this is my long string. ");
str.Append("this is my really long string.  this is my long string. ");
str.Append("this is my really long string.  this is my long string. ");
str.Append("this is my really long string.  this is my long string. ");
string s = str.ToString();

您还可以使用：文本文件、资源文件、数据库和注册表。

Answer 11

必须在源文件中定义吗？否则，在资源或配置文件中定义它。