怎么告诉javadoc我的期间没有结束一个句子

Question

javadoc使用doc评论的第一个“句子”作为摘要句子。它假定一个句点后跟空格，制表符或行终止符结束句子。假设我想要一个像“eg”这样的缩写或“等”在我的总结中;有没有办法告诉javadoc不要把它当作句子的结尾？我可以用.替换句号，但我想知道是否有一种不那么丑陋的方式。

Answer 1

最好避免在第一句中出现句号。在How to Write Doc Comments for the Javadoc Tool中，建议您将空格字符替换为变通方​​法：

 /**
 * This is a simulation of Prof. Knuth's MIX computer.
 */

 /**
  * This is a simulation of Prof.<!-- --> Knuth's MIX computer.
  */

就个人而言，如果我无法完全避免缩写，我会省略点。