我问自己如何在Java文档中显示输出示例。看这里...
/**
* Returns the app's version-info (e.g.: "App 1.2").
*/
public static String getAppVersionInfo() {
return getAppName() + " " + getVersionName();
}
如何以方便的方式表达“ eg”？
据我所知，Javadoc没有用于示例值的特殊标记。
我记得遇到的与您所描述的最接近的事情将是中的哈希算法示例MessageDigest#getAlgorithm()。在那种情况下，作者只是说
...名称应为标准的Java安全性名称（例如“ SHA”，“ MD5”等）。...
还有Javadoc HowTo，它特别禁止使用“ eg”：
避免拉丁
使用“也称为”代替“ aka”，使用“ that”或“要具体”代替“ ie”，使用“例如”代替“ eg”，并使用“换句话说”或“即”而不是“ viz”。
除此之外，我不知道适用于您情况的任何规则或最佳做法。
本文收集自互联网，转载请注明来源。
如有侵权，请联系[email protected] 删除。
我来说两句