具有非描述性变量名称的可维护代码答案

【问题标题】：Maintainable code with non-descriptive variable names具有非描述性变量名称的可维护代码
【发布时间】：2015-07-19 01:42:25
【问题描述】：

我正在使用 LexisNexis VisualFiles，它的脚本语言不允许使用描述性变量名称 - 它只允许命名为 TF01、TF02 或 LF01、LF02 等的“临时字段”和“本地字段”。其他数据来自“entities”，因此任何实体的描述性名称都是“selectedentity.EN01”。

这很难维护，尤其是我正在编辑的很多内容在编写时都没有评论。特别是，如果我在编写一段代码后发现我需要使用一个新变量，我发现我只是在尝试发明我有理由确定没有在其他任何地方使用过的变量编号。有没有人对如何使这样的代码具有可读性和可维护性有任何建议，而不是手动注释每一行？

编辑：这不是 ECL，这是 Visualfiles 的脚本语言。我在网上找不到任何资源，我唯一的参考是软件附带的帮助文件。这是我试图破译的那种代码：

[&Assign LF12=""]
[&Assign LF13=""]
[&Assign LF10=ARAN_AAFOO.en02]
[&Assign LF11=ARAN_AAFOO.EN56]
[&Assign LF12=ARAN_AAFOO.ABAR_ARAN.DET03]
[&Assign LF13=ARAN_AAFOO.ABAR_ARAN.DET02]
[&If LF12<> "This" &And LF12 <> "That"]
    [&If LF13=""]
      [&Assign LF13="Something"]
    [&Else]
      [&Assign LF13=LF13]
    [&EndIf]
    [&If DET12="Yes"] **priority
      [&Assign LF35="Top"]
      [&Assign LF36="abnormal"]
    [&Else]
      [&Assign LF35="Bottom"]
      [&Assign LF36="normal"]
    [&EndIf]

任何变量都可以是任何类型，所以我正在寻找一个系统来帮助我保持井井有条并跟踪我正在编写的内容 - 如果“评论所有内容”是唯一也可以的解决方案。

【问题讨论】：

你似乎在谈论ECL - 你手头有关于这种脚本语言语法的一些描述的链接吗？

标签： database scripting data-visualization data-analysis variable-names

【解决方案1】：

您总是可以使用已声明的变量。在“帮助”中搜索 &DECLARE。这是他们给出的一个例子[&Declare CurrentVATRate = "17.5"]

【讨论】：

【解决方案2】：

不幸的是，没有一个简单的方法。也许在脚本顶部使用每个 LF 旁边的注释来初始化脚本顶部的 LF 字段，说明它与什么相关。值得记住的是，LF 字段仅对该脚本\文档是本地的，而 TF 是在会话期间，即将在脚本之间进行。尽可能尝试使用 LF 字段是值得的。您也可以右键单击一个字段，例如您示例中的 DET12 字段，它会为您提供字段标签。

这一切都非常混乱，没有数据库领域的先验知识和良好的评论，维护别人的工作可能是一场噩梦。

【讨论】：

我决定明智的做法是编写具有描述性变量名称的代码，以便易于使用，然后在顶部的部分中为每个变量分配 LF 编号每个文件。这样我就可以对每个变量进行搜索和替换，在需要对其进行工作时将脚本转换为人类友好的形式。通过右键单击获取字段标签非常有用，谢谢。