编写java文档 - 显示输出示例

Question

我问自己如何在java文档中显示输出的示例。 看到这里......

/**
 * Returns the app's version-info (e.g.: "App 1.2").
 */
public static String getAppVersionInfo() {
    return getAppName() + " " + getVersionName();
}

如何表达＆＃39;例如＆＃39;方便吗？

Answer 1

据我所知，Javadoc没有示例值的特殊标记。

我记得遇到的最接近你所描述的内容将是MessageDigest#getAlgorithm()中哈希算法的例子。在这种情况下，作者只是说

  

...名称应该是标准的Java安全名称（例如“SHA”，“MD5”等）。 ...

还有Javadoc HowTo，它特别不鼓励使用“例如”：

  

避免使用拉丁语

     

使用“也称为”而不是“aka”，使用“that is”或“to specific”而不是“ie”，使用“例如”代替“eg”，并使用“换句话说”或“即”而不是“即”。

除此之外，我不了解适用于您情况的任何规则或最佳做法。