Javadoc when generating help documents, note the following points

Reference: http://www.w3school.com.cn/tags/tag_pre.asp

Javadoc when generating help documents, note the following points:

1, Function function Description of the end must have a period, English period or Chinese period can be. Or there will be a way. A large piece of content will appear in the summary.

2. <p> for Line changing

3. <pre> elements can define pre-formatted text. Text that is enclosed in the pre element usually retains spaces and line breaks. The text is also rendered as an equal-width font.

 Public class javadocdemo{  /**@param@return * /　　publicstatic  string func (String str) {  return  str; }}　　

The resulting help document is as follows

Reference

1, reference Java Source object class Wait () method

    /*** Causes the current thread to wait until another thread invokes the * {@linkjava.lang.object#notify ()} method or the * {@linkJava.lang.object#notifyall ()} method for this Object, or * some other thread interrupts the current thread, or a     Certain * amount of real time has elapsed. * <p> * This method was similar to the {@codeWait} method of one * argument, but it allows finer control over the amount of time to * wait for a notificat Ion before giving up. The amount of real time, * measured in nanoseconds, was given by: * <blockquote> * <pre> * 1000 000*timeout+nanos</pre></blockquote> * <p> * In all other respects, this method does the same th ing as the * method {@link#wait (Long)} of one argument. In particular, * {@codeWait (0, 0)} means the same thing as {@codeWait (0)}. * <p> * The current thread must own this object ' s monitor. The thread * Releases ownership of this monitor and waits until either of the * following have conditions Red: * <ul> * <li>another thread notifies threads waiting on this object ' s monitor * to wake u P either through a call to the {@codeNotify} method * or the {@codeNotifyall} method. * <li>the timeout period, specified by {@codeTimeout} * milliseconds plus {@codeNanos} nanoseconds arguments, has * elapsed. * </ul> * <p> * The thread then waits until it can re-obtain ownership of the * monitor and resume     S execution. * <p> * As in the one argument version, interrupts and spurious wakeups is * possible, and this method shou LD always is used in a loop: * <pre> * synchronized (obj) {* while (&lt;condition does     Not hold&gt;) * obj.wait (timeout, Nanos); * ...//Perform action appropriate to condition *} * </pre> * The method should only is C Alled by a thread, that's the owner * of this object ' s monitor. See the {@codeNotify} method for A * Description of the ways in which a thread can become the owner of * a monitor. *     * @paramtimeout The maximum time to wait in milliseconds. * @paramNanos additional time, in nanoseconds range * 0-999999. * @throwsIllegalArgumentException If the value of timeout is * negative or the value of Nanos I     S * Not in the range 0-999999. * @throwsIllegalmonitorstateexception if the current thread was not * The owner of this object ' s monitor. * @throwsinterruptedexception If any thread interrupted the "current" thread before or while the current thre  AD * was waiting for a notification. The <i>interrupted * status</i> of the current thread was cleared when * this E     Xception is thrown. */     Public Final voidWaitLongTimeoutintNanosthrowsinterruptedexception {if(Timeout < 0) {            Throw NewIllegalArgumentException ("Timeout value is negative"); }        if(Nanos < 0 | | Nanos > 999999) {            Throw NewIllegalArgumentException ("Nanosecond timeout value out of range"); }        if(Nanos > 0) {Timeout++;    } wait (timeout); }

2, >>html label definition <<

Javadoc when generating help documents, note the following points