Come dire a javadoc che il mio periodo non termina una frase

Question

javadoc utilizza la prima "frase" di un commento di un documento come una frase di riepilogo. Presuppone che un periodo seguito da uno spazio, una tabulazione o un terminatore di riga termini la frase. Supponiamo che io voglia un'abbreviazione come "ad es." o "ecc." nel mio riassunto; c'è un modo per dire a Javavoc di non trattarlo come la fine di una frase? Posso sostituire il periodo con . ma mi chiedo se c'è un modo meno brutto.

Answer 1

È consigliabile evitare i periodi nella prima frase. In How to Write Doc Comments for the Javadoc Tool è suggerito che si dovrebbe sostituire il carattere di spazio come una soluzione:

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

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

Personalmente, vorrei solo omettere il punto se non ho potuto evitare del tutto le abbreviazioni.