javadoc - 生理が文の終わりではないことを javadoc に伝える方法

Question

javadoc は、doc コメントの最初の「文」を要約文として使用します。ピリオドの後にスペース、タブ、または行末記号が続くと、文が終了すると見なされます。「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.
  */

個人的には、略語を完全に避けることができない場合は、ドットを省略します.