javadoc - 如何告诉 javadoc 我的期间没有结束一个句子

Question

javadoc 使用文档注释的第一个“句子”作为摘要句。它假定句点后跟空格、制表符或行终止符来结束句子。假设我想要一个缩写，如“eg”或“etc”。在我的总结中；有没有办法告诉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.
  */

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