How to tell javadoc that my term does not end with a sentence

javadoc uses the first "sentence" of the doc comment as a summary sentence. He suggests that a period followed by a space, tab, or line terminator ends the sentence. Suppose I need an abbreviation like "for example." or "etc." in my resume; is there any way to tell javadoc not to consider it as the end of a sentence? I can replace the period . but I wonder if there is a less ugly way.

+8
javadoc
source share
1 answer

It is better to avoid periods in the first sentence. In How to write Doc comments for the Javadoc Tool , you suggested replacing the space character as a workaround:

  /** * This is a simulation of Prof.&nbsp;Knuth MIX computer. */ /** * This is a simulation of Prof.<!-- --> Knuth MIX computer. */ 

Personally, I would just drop the point if I could not avoid the abbreviations at all.

+4
source share

All Articles