使用 JavaDoc 记录地图的标准方法是什么？

Question

我正在记录一些代码，并且我有一个私有的 HashMap。我想指定有关键和值的预期信息。现在我有：

/**
 * HashMap where key=word, value=part of speech
 */
private HashMap<String, String> dictionary;

然而，这似乎很难阅读，而且当我有更复杂的东西时它也不会很好用

HashMap<String, HashMap<String, String>>

记录地图的最佳/常见做法是什么？

Answer 1

如果你需要一个小的 javadoc，我建议如下：

/**
 * Dictionary is a {@link Map} collection that contains {@link Object1} as
 * key and {@link Object2} as value.
 */
private Map<Object1, Object2> dictionary = new HashMap<>();

@link keywork 会将您重定向到实例定义。

注意：应该首选使用接口作为类型（Map 而不是 HashMap）。