你如何维护你的程序词汇？

Question

在一个不那么小的程序中，当你没有那么少的实体时，为了保持代码可读性，通用术语，以及其他方面增进团队成员之间的相互理解，必须定义和维护程序词汇。

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

Answer 1

大多数合理规模的项目都应该有一个编程/编码标准文件，规定了应遵循的共同惯例和命名准则。

另一种帮助解决此问题的方法是通过代码审查。显然，审稿人之间需要进行一些协调（该文件也有助于此）。代码审查有助于使更环保的开发人员和高级开发人员保持正轨，并作为执行编码标准的途径。

Answer 2

@Ilya Ryzhenkov，

我担心大多数公司都没有这样的做法:)我曾经在拥有数百万LOC代码库的不那么小的公司工作过，他们根本没有任何文档（除了常见的编码指南）

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

Wiki方法被证明是不适用的，因为没有人关心定期更新它：）

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

Answer 3

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

Answer 4

Domain Driven Design在这里很有趣，因为它鼓励程序员接受域词汇。最重要的是，有一些设计约定，允许您使用众所周知的术语（如服务，存储库，工厂等）来引用应用程序的各个部分。

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

Answer 5

我的团队在维基上保留这种信息（约定/词汇等）。这样可以很容易地保持最新并分享。