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

Question

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

awk '{
    for (i = 1; i <= NF; i++) 
        if ($i > 40000) {
            print
            break
        }
}' file

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

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

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

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）。