你如何保持你的节目词汇量？ [关闭]

Posted 2023-04-14

【中文标题】你如何保持你的节目词汇量？ [关闭]

【英文标题】：How do you maintain your program vocabulary? [closed]

【发布时间】：2010-09-11 20:20:29

【问题描述】：

在一个不那么小的程序中，当你的实体不那么少时，为了保持代码的可读性、通用术语，或者提高团队成员之间的相互理解，必须定义和维护节目词汇。

你（或你的公司）如何处理这项任务，你有什么纪律，你有什么安排？

【参考方案1】：

大多数规模合理的项目都应该有一份编程/编码标准文档，其中规定了应遵循的通用约定和命名准则。

另一种帮助解决此问题的方法是通过代码审查。显然，审阅者之间需要进行一些协调（该文档也有助于此）。代码审查有助于让更环保的开发人员和高级开发人员都走上正轨，并充当执行编码标准的途径。

【讨论】：

问题是“如何”而不是“什么”

也许在问题中澄清一下，然后呢？你问怎么做，迈克尔用标准文件说。

William，所以您认为只要有一个“标准”文档就可以使程序词汇表易于维护吗？

在我的公司，通常为每个项目定制约定文件，以纳入客户提出的任何风格和 DSL。

我刚刚添加了代码审查方法。

【参考方案2】：

@Ilya Ryzhenkov，

恐怕大多数公司都没有这样的做法 :) 我曾在一家拥有数百万 LOC 代码库的不那么小的公司工作，他们根本没有任何文档（除了通用编码指南）

在我的一个项目中，我们维护了应用程序领域中常用术语的词库，并在代码审查期间使用它。我不时分析 .NET XML 文档差异，以决定应将哪些实体\术语添加到同义词库中。强制遵守词库的唯一方法是编码指南。

Wiki 方法被证明是不适用的，因为没有人愿意定期更新它:)

我想知道您在 JetBrains 使用什么方法？我在 Reflector 中检查了 ReSharper 的代码，对实体的数量和名称感到惊讶:)

【参考方案3】：

将您的包/模块划分为逻辑组，并使用描述性和简洁的名称。避免使用通用名称，除非它们真的是计数器等。为功能组或功能组创建约定并遵守它们。

【讨论】：

创建约定后，我将如何维护它们？

【参考方案4】：

领域驱动设计在这里很有趣，因为它鼓励程序员接受领域词汇。除此之外，还有一些设计约定，允许您使用众所周知的术语来引用应用程序的某些部分，例如服务、存储库、工厂等。

结合领域词汇并使用上面的技术约定可能是一个很好的解决方案。

【参考方案5】：

我的团队将此类信息（约定/词汇等）保存在 wiki 上。这样可以轻松了解最新情况并进行分享。

【讨论】：

我想知道您如何保持最新状态？关于“当您将 IFooElement 更改为 IFooEntity 时，请更新页面 a、b 和 c 上的 wiki”，您是否有任何规则？

如果人们很懒惰，这可能会出现问题。有用的页面会随着人们频繁使用而保持更新，如果您发现问题/错误，则必须对其进行修复。应该删除不太有用的页面或将其合并为更易于维护的有用页面。