Java的通用类型参数命名约定（带有多个字符）？

Question

在我编写的某些接口中，我想用多个字符命名泛型类型参数，以使代码更具可读性。

类似......

Map<Key,Value>

而不是这个...

Map<K,V>

但是当涉及到方法时，类型参数看起来像 java-classes，这也令人困惑。

public void put(Key key, Value value)

这似乎 Key 和 Value 是类。我发现或想到了一些符号，但没有像 Sun 的约定或一般最佳实践。

我猜到或找到的替代方案...

Map<KEY,VALUE>
Map<TKey,TValue>

Answer 1

Oracle 在Java Tutorials > Generics > Generic Types 中推荐以下内容：

类型参数命名约定

按照惯例，类型参数名称是单个大写字母。这与您已经知道的变量naming 约定形成鲜明对比，并且有充分的理由：如果没有这种约定，就很难区分类型变量和普通类或接口名称。

最常用的类型参数名称有：

• E - 元素（Java 集合框架广泛使用）
• K - 键
• N - 编号
• T - 类型
• V - 值
• S、U、V 等 - 第 2、第 3、第 4 类

您将在整个 Java SE API 和本课的其余部分中看到这些名称。

我会坚持这样做，以避免在开发人员和可能的维护人员之间造成混淆。

Answer 2

追加Type

可以在 DZone 页面上的 cmets 中找到很好的讨论，Naming Conventions for Parameterized Types。

查看 Erwin Mueller 的评论。他的建议对我来说非常明显：添加单词Type。

称苹果为苹果，汽车为汽车。有问题的名称是数据类型的名称，对吧？ （在OOP 中，一个类本质上定义了一种新的数据类型。）所以称它为“类型”。

Mueller 的示例，取自原始帖子的文章：

public interface ResourceAccessor < ResourceType , ArgumentType , ResultType > {
    public ResultType run ( ResourceType resource , ArgumentType argument );
}

追加T

Andy Thomas 提供了一个重复的问题 this Answer。请注意 Google 样式指南的摘录，其中建议多字符类型名称应以单个大写 T 结尾。

Answer 3

是的，您可以对类型变量使用多字符名称，只要它们与类名有明显区别。

这与 Sun 在 2004 年引入泛型时建议的惯例不同。但是：

• 存在不止一种约定。
• 多字符名称与其他Java风格一致，如Google’s style for Java。
• 可读的名称（惊喜！）更具可读性。

可读性

在我写的一些接口中，我想用多个字符来命名泛型类型参数，以使代码更具可读性。

可读性很好。

比较：

    public final class EventProducer<L extends IEventListener<E>,E> 
            implements IEventProducer<L,E> {

到：

    public final class EventProducer<LISTENER extends IEventListener<EVENT>,EVENT> 
           implements IEventProducer<LISTENER, EVENT> {

或者，使用 Google 的多字符约定：

    public final class EventProducer<ListenerT extends IEventListener<EventT>,EventT> 
           implements IEventProducer<ListenerT, EventT> {

    public final class EventProducer<ListenerT extends IEventListener<EventT>,EventT> 
           implements IEventProducer<ListenerT, EventT> {

谷歌风格

Google Java Style Guide 允许单字母名称和以 T 结尾的多字符类类名称。

5.2.8 Type variable names

每个类型变量都以两种样式之一命名：

• 一个大写字母，后跟一个数字（例如E、T、X、T2）

• 用于类的名称（参见第 5.2.2 节，Class names），后跟大写字母 T（例如：RequestT，FooBarT）。

  李>

问题

“如果没有这个约定，就很难区分类型变量和普通类或接口名称。” – 来自Oracle tutorials, “Generic types”

正如我们在上面看到的那样，单字符名称并不是区分类型参数和类名的唯一方法。

为什么不在 JavaDoc 中记录类型参数的含义？

@param JavaDoc 元素确实可以提供更长的描述。但是，JavaDocs 不一定是可见的，这也是事实。 （例如，Eclipse 中有一个显示类型参数名称的内容辅助。）

多字符类型参数名称不遵循 Oracle 约定！

Java 编程中几乎普遍遵循 Sun 的许多原始约定。

但是，这个特定的约定不是。

竞争公约中的最佳选择是见仁见智。在这种情况下，选择 Oracle 以外的约定的后果很小。您和您的团队可以选择最能满足您需求的约定。

Answer 4

您可以使用 javadoc 至少为您的泛型类的用户提供线索。我仍然不喜欢它（我同意@chaper29），但文档有所帮助。

例如，

/**
 * 
 * @param <R> - row
 * @param <C> - column
 * @param <E> - cell element
 */
public class GenericTable<R, C, E> {

}

我知道做的另一件事是使用我的 IDE 重构一个打破惯例的类。然后处理代码并将其重构回单个字母。如果使用许多类型参数，无论如何都会让我更容易。

Answer 5

official naming convention推荐使用单字母的原因如下：

没有这个约定，就很难区分 在类型变量和普通类或接口名称之间。

我认为对于现代 IDE，这个理由不再有效，例如。 IntelliJ Idea 以不同于常规类的颜色显示泛型类型参数。

IntelliJ Idea 2016.1 中显示的具有泛型类型的代码

由于I use longer descriptive names 我的泛型类型的区别，与常规类型具有相同的约定。我避免添加诸如 T 或 Type 之类的前缀和后缀，因为我认为它们是不必要的干扰，并且不再需要在视觉上区分泛型类型。

注意：由于我不是 Eclipse 或 Netbeans 的用户，我不知道它们是否提供了类似的功能。