单独 .pas 文件中的字符串

Question

这可能不是这个问题的正确位置，如果不合适请随意移动它。我标记为 Delphi/Pascal 因为这是我在 atm 中工作的，但这可能适用于我猜的所有编程。

不管怎样，我正在做一些代码清理，并考虑将程序中的所有字符串移动到一个单独的 .pas 文件中。这样做有什么优点和缺点吗？这还值得做吗？

澄清一下：我的意思是我将创建一个单独的文件 Strings.pas，在其中我将创建所有文本字符串变量。

当前

代码

 Messages.Add('The voucher was NOT sent to ' + sName+
                          ' because the application is in TEST MODE.');
 Messages.Add('Voucher Saved to ' + sFullPath);
 Messages.Add('----------------------------------------------------------');

新代码类似于：

Messages.Add(sMsgText1 + '' + sName + '' + sMsgText2 + '' + sFullPath)

Strings.pas 文件将保存所有字符串数据。希望这更有意义

Answer 1

将字符串移动到单独的文件中是个好主意！它将它们保持在一起，并让您在需要时轻松更改它们。你的问题并不是说你希望能够翻译它们，但集中化将有助于实现这一点。

但是，像这样的代码

Messages.Add(sMsgText1 + '' + sName + '' + sMsgText2 + '' + sFullPath)

并不比这样的代码更好：

Messages.Add('The voucher was NOT sent to ' + sName+
                      ' because the application is in TEST MODE.');

您已经将一个混乱但可读的函数调用变成了一个混乱且不可读的函数调用。使用旧代码（上面的第二个片段），您可以阅读代码并大致了解消息将要说什么，因为其中很多内容都是文本形式的。使用新代码，您就不能这样做。

其次，移动字符串的原因是为了将相关项目放在一起并更容易更改它们。如果您想更改上述消息，而不是说“路径‘bar’中的文件‘foo’...”，而是改为“文件 bar\foo 是...”，该怎么办？你不能：消息的构建方式仍然是固定的并且分散在整个代码中。如果您想以相同的方式更改多条消息的格式，则需要更改许多单独的位置。

如果您的目标是翻译消息，这将是一个更大的问题，因为翻译通常需要重新措辞消息而不仅仅是翻译组件。 （例如，您需要更改消息中包含的子项目的顺序 - 您不能只是假设每种语言都是顺序替换中的短语对短语。）

进一步重构

我建议进行更积极的重构您的消息代码。当您建议将邮件移至单独的文件时，您绝对是在正确的轨道上。但不要只移动字符串：还要移动函数。不要在代码中分散大量 Messages.Add('...')，而是找到您创建的消息的公共子集。很多都会非常相似。创建一系列可以调用的函数，以便使用单个函数实现所有类似的消息，并且如果您需要更改它们的措辞，可以在单个位置完成。

例如，而不是：

Messages.Add('The file ' + sFile + ' in ' + sPath + ' was not found.');
... and elsewhere:
Messages.Add('The file ' + sFileName + ' in ' + sURL + ' was not found.');

有一个函数：

Messages.ItemNotFound(sFile, sPath);
...
Messages.ItemNotFound(sFileName, sURL);

您将得到：

• 集中的消息字符串
• 集中的消息函数
• 更少的代码重复
• 更干净的代码（在函数调用中没有字符串组装，只有参数）
• 更容易翻译 - 提供函数的替代实现（不要忘记，仅仅翻译子字符串可能还不够，您通常需要能够大幅改变措辞。）
• 函数名称中消息内容的清晰描述，例如 ItemNotFount(item, 它会导致
• path)，当你阅读它时，

更清晰的代码，这对我来说听起来不错:)

Answer 2

我认为将所有字符串常量移动到一个单元很有意义。它使更改文本变得更加容易，特别是如果您想翻译成其他（人类）语言。

但是你为什么不做我通常做的事情而不是字符串，即使用resourcestring。这样，其他人就可以使用资源编辑器更改您的字符串，而无需重新编译。

unit Strings;

resourcestring
  strMsgText1 = 'The voucher was NOT sent to ';

etc...

但这样的字符串可能更好地完成为：

resourcestring
  strVoucherNotSent = 
    'The voucher was NOT sent to %s because the application is in TEST MODE.';
  strVoucherForNHasValueOf =
    'The voucher for %s has a value of $%.2f'; 

这样做的优点是在某些语言中，此类替换的位置和顺序是不同的。这样，译者就可以将论点放在任何需要的地方。当然，应用程序必须使用 Format() 来处理字符串：

Messages.Add(Format(strVoucherNotSent, [sName]));
Messages.Add(Format(strVoucherSavedTo, [sFullPath]));
Messages.Add(Format(strVoucherForNHasValueOf, [sName, dblValue]));

Answer 3

如果您想将 UI 翻译成不同的语言，那么将所有文本放在一个文件中，或者可能是多个专门用于声明字符串常量的文件中，您可能会受益匪浅。

但是，如果您在没有如此强烈的动机的情况下进行此更改，那么您的代码可能会变得难以阅读。

一般来说，你必须问这样一个重大重构的好处是什么，如果它们不是不言而喻的，那么你很可能只是为了改变而改变。

Answer 4

如果您想翻译您的应用程序，请考虑使用 Gnu GetText for delphi，也称为 dxGetText。这比将字符串放入单独的 .pas 文件更好，因为它允许您无需任何特殊工具、任何重新编译即可启用翻译，甚至无需最终用户进行。

Answer 5

嗯，这里的共识似乎倾向于赞成的一方，我完全同意这一点。错误地过度使用字符串文字可能会导致您的源代码变成字符串类型。

我仍然缺少的一项好处是字符串的可重用性。尽管这不是运送到另一个单元的直接好处，但它是通过将字符串文字移动到常量而获得的。

但一个相当重要的缺点是创建这个单独的源文件需要时间。您可能会考虑在下一个项目中实施这个良好的编程实践。这完全取决于您是否有足够的时间（例如爱好项目）或截止日期，是否有下一个项目（例如学生），或者只是想做一些练习。就像 David H 的答案和评论一样，就像您所做的所有决定一样做，你必须权衡好处。

除了可以提供一些自动帮助的各种奇特的重构工具之外，要认识到仅将字符串文字移动到另一个单元并不能完成工作。就像 Rudy 和 David M 已经回答了，您必须部分重写源代码。此外，找到可读、简短且适用的常量名称确实需要时间。正如许多评论已经指出的那样，控制拼写一致性很重要，我认为同样的论点也适用于替换常量本身。

关于翻译答案，无论是否适用于 OP，将所有源字符串移动到单独的单元只是翻译解决方案的一部分。您还必须注意设计器字符串（即标题）和 GUI 兼容性：较长的翻译仍然必须适合您的标签。

如果您有奢侈或需要：那就去吧。但我会把它带到下一个项目中。

Answer 6

我确实在旧版本的框架中将所有文字与资源字符串分组。我从中回来，因为在框架中，您可能不会使用框架中的所有字符串（例如，因为某些单元或单元组未使用，但扫描通用目录将显示翻译工具中的所有字符串）。

现在我再次将它们分配给各个单位。 较小问题（*）。

我最初开始将它们分组以避免重复，但回想起来，这是在“公共”目录上使用 dxgettext 的