标签命名策略

Question

我学的是物理，用 LaTeX 排版数学内容较多的文章。虽然我能很快地写出 LaTeX，但我经常发现自己花了太多时间思考方程标签的合理名称。

我已经认识到与此相关的几个明显问题。首先，我经常发现很难为我的方程式起一个简洁但描述性的名称。当我对某种方程式有多个变体时，这尤其困难。所以我可能有一个名为“GeneralizedAction”的方程式，还有一个名为“GeneralizedActionWithEvolutionParameter”的方程式和另一个名为“GeneralizedActionWithKinematicalVariables”的方程式。一段时间后，这可能会变得相当荒谬。

另一个问题是，有些方程很难命名。这种情况经常发生在做笔记的时候，例如，在做笔记时，没有事先想好说明的内容。这里的方程通常没有明显的名称，但数学推导可能需要大量引用这些方程。当笔记一步步增加时，问题就变得更加严重。一个一开始看起来很明显的名称可能会在以后成为障碍。

我确信我不是唯一一个遇到这个问题的人，但我几乎找不到有关这个特定问题的任何信息。您如何管理标签名称？

Answer 1

我不知道这是否是最好的策略，但目前我对此并不感到不满意。基本上，我坚持罗伯特·马丁在他的书《代码完成》中的想法。他指出，代码应该自我解释，以摆脱注释等。他强迫读者使用很长的变量名，但解释关于变量的所有信息（使用、原因等）。所以我的命名策略是进行某种层次化的广泛命名。由于大多数现代 IDE 支持文本完成，其他 IDE 甚至保留标签列表，因此在文档中引用时不必完整输入标签。从一个文档到另一个文档，我使用其他特定的层次结构方案，但我尝试保持这样的形式

label(eq:topicA:equationDescriptiveIdentifier:ArbitrarilyChosen:ButVerySpecific)

层次结构由冒号组成。一个层次结构是较低的 CamelCase 命名。我必须承认，在以后的写作过程中，层次结构可能会发生变化。这绝对是这种方法的弱点。

我认为使用 TexStudio 之类的 IDE 来使用标签和引用效果非常好。正如 Sigur 所评论的那样，这个 IDE 还可以选择在不滚动代码的情况下预览相关代码。我也使用showkeys包来起草文档。