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

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

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

---

如何以一种方便的方式表达“e.g.”？

据我所知，Javadoc没有一个特殊的标记来表示示例值

我记得我遇到过的与您描述的最接近的是中的哈希算法示例。在这种情况下，作者只是说

。。。该名称应该是一个标准的Java安全名称（如“SHA”、“MD5”等）

还有一个特别不鼓励使用“例如”的：

避免使用拉丁语

使用“也称为”而不是“aka”，使用“即”或“具体”而不是“即”，使用“例如”而不是“例如”，使用“换句话说”或“即”而不是“即”

---

除此之外，我不知道任何适用于您的情况的规则或最佳实践。

定义正确的方法。Javadoc支持HTML，并具有特殊的标记以链接到现有类。这里有很多可能性。一个常用的符号？^^^谢谢肉桂，“如”-表达在我看来很整洁。