javadocで期間が文を終了しないようにする方法

Question

javadocは、文書コメントの最初の "sentence"を要約文として使用します。ピリオド、スペース、タブ、または行ターミネータの後にピリオドが続くと仮定します。たとえば、「たとえば」のような略語が必要な場合は、または "等"私の要約では、 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. 
    */ 

個人的に、私はちょうどドットを省略します。