如何用记事本生成API文档？javadoc命令使用

1》在我们jdk的bin目录下有一个javadoc可执行程序

其作用是根据java源文件生成doc文档&＃xff0c;也就是api文档

2》我们可以自己用记事本来编写一段java源文件

这里我直接copy了一份PrintStream 类源码

/** Copyright (c) 1996, 2013, Oracle and/or its affiliates. All rights reserved.* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.** This code is free software; you can redistribute it and/or modify it* under the terms of the GNU General Public License version 2 only, as* published by the Free Software Foundation. Oracle designates this* particular file as subject to the "Classpath" exception as provided* by Oracle in the LICENSE file that accompanied this code.** This code is distributed in the hope that it will be useful, but WITHOUT* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License* version 2 for more details (a copy is included in the LICENSE file that* accompanied this code).** You should have received a copy of the GNU General Public License version* 2 along with this work; if not, write to the Free Software Foundation,* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.** Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA* or visit www.oracle.com if you need additional information or have any* questions.*/package java.io;import java.util.Formatter;
import java.util.Locale;
import java.nio.charset.Charset;
import java.nio.charset.IllegalCharsetNameException;
import java.nio.charset.UnsupportedCharsetException;/*** A PrintStream adds functionality to another output stream,* namely the ability to print representations of various data values* conveniently. Two other features are provided as well. Unlike other output* streams, a PrintStream never throws an* IOException; instead, exceptional situations merely set an* internal flag that can be tested via the checkError method.* Optionally, a PrintStream can be created so as to flush* automatically; this means that the flush method is* automatically invoked after a byte array is written, one of the* println methods is invoked, or a newline character or byte* (&＃39;\n&＃39;) is written.**

All characters printed by a PrintStream are converted into* bytes using the platform&＃39;s default character encoding. The {&＃64;link* PrintWriter} class should be used in situations that require writing* characters rather than bytes.** &＃64;author Frank Yellin* &＃64;author Mark Reinhold* &＃64;since JDK1.0*/public class PrintStream extends FilterOutputStreamimplements Appendable, Closeable
{private final boolean autoFlush;private boolean trouble &＃61; false;private Formatter formatter;/*** Track both the text- and character-output streams, so that their buffers* can be flushed without flushing the entire stream.*/private BufferedWriter textOut;private OutputStreamWriter charOut;/*** requireNonNull is explicitly declared here so as not to create an extra* dependency on java.util.Objects.requireNonNull. PrintStream is loaded* early during system initialization.*/private static T requireNonNull(T obj, String message) {if (obj &＃61;&＃61; null)throw new NullPointerException(message);return obj;}/*** Returns a charset object for the given charset name.* &＃64;throws NullPointerException is csn is null* &＃64;throws UnsupportedEncodingException if the charset is not supported*/private static Charset toCharset(String csn)throws UnsupportedEncodingException{requireNonNull(csn, "charsetName");try {return Charset.forName(csn);} catch (IllegalCharsetNameException|UnsupportedCharsetException unused) {// UnsupportedEncodingException should be thrownthrow new UnsupportedEncodingException(csn);}}/* Private constructors */private PrintStream(boolean autoFlush, OutputStream out) {super(out);this.autoFlush &＃61; autoFlush;this.charOut &＃61; new OutputStreamWriter(this);this.textOut &＃61; new BufferedWriter(charOut);}private PrintStream(boolean autoFlush, OutputStream out, Charset charset) {super(out);this.autoFlush &＃61; autoFlush;this.charOut &＃61; new OutputStreamWriter(this, charset);this.textOut &＃61; new BufferedWriter(charOut);}/* Variant of the private constructor so that the given charset name* can be verified before evaluating the OutputStream argument. Used* by constructors creating a FileOutputStream that also take a* charset name.*/private PrintStream(boolean autoFlush, Charset charset, OutputStream out)throws UnsupportedEncodingException{this(autoFlush, out, charset);}/*** Creates a new print stream. This stream will not flush automatically.** &＃64;param out The output stream to which values and objects will be* printed** &＃64;see java.io.PrintWriter#PrintWriter(java.io.OutputStream)*/public PrintStream(OutputStream out) {this(out, false);}/*** Creates a new print stream.** &＃64;param out The output stream to which values and objects will be* printed* &＃64;param autoFlush A boolean; if true, the output buffer will be flushed* whenever a byte array is written, one of the* println methods is invoked, or a newline* character or byte (&＃39;\n&＃39;) is written** &＃64;see java.io.PrintWriter#PrintWriter(java.io.OutputStream, boolean)*/public PrintStream(OutputStream out, boolean autoFlush) {this(autoFlush, requireNonNull(out, "Null output stream"));}/*** Creates a new print stream.** &＃64;param out The output stream to which values and objects will be* printed* &＃64;param autoFlush A boolean; if true, the output buffer will be flushed* whenever a byte array is written, one of the* println methods is invoked, or a newline* character or byte (&＃39;\n&＃39;) is written* &＃64;param encoding The name of a supported* * character encoding** &＃64;throws UnsupportedEncodingException* If the named encoding is not supported** &＃64;since 1.4*/public PrintStream(OutputStream out, boolean autoFlush, String encoding)throws UnsupportedEncodingException{this(autoFlush,requireNonNull(out, "Null output stream"),toCharset(encoding));}/*** Creates a new print stream, without automatic line flushing, with the* specified file name. This convenience constructor creates* the necessary intermediate {&＃64;link java.io.OutputStreamWriter* OutputStreamWriter}, which will encode characters using the* {&＃64;linkplain java.nio.charset.Charset#defaultCharset() default charset}* for this instance of the Java virtual machine.** &＃64;param fileName* The name of the file to use as the destination of this print* stream. If the file exists, then it will be truncated to* zero size; otherwise, a new file will be created. The output* will be written to the file and is buffered.** &＃64;throws FileNotFoundException* If the given file object does not denote an existing, writable* regular file and a new regular file of that name cannot be* created, or if some other error occurs while opening or* creating the file** &＃64;throws SecurityException* If a security manager is present and {&＃64;link* SecurityManager#checkWrite checkWrite(fileName)} denies write* access to the file** &＃64;since 1.5*/public PrintStream(String fileName) throws FileNotFoundException {this(false, new FileOutputStream(fileName));}/*** Creates a new print stream, without automatic line flushing, with the* specified file name and charset. This convenience constructor creates* the necessary intermediate {&＃64;link java.io.OutputStreamWriter* OutputStreamWriter}, which will encode characters using the provided* charset.** &＃64;param fileName* The name of the file to use as the destination of this print* stream. If the file exists, then it will be truncated to* zero size; otherwise, a new file will be created. The output* will be written to the file and is buffered.** &＃64;param csn* The name of a supported {&＃64;linkplain java.nio.charset.Charset* charset}** &＃64;throws FileNotFoundException* If the given file object does not denote an existing, writable* regular file and a new regular file of that name cannot be* created, or if some other error occurs while opening or* creating the file** &＃64;throws SecurityException* If a security manager is present and {&＃64;link* SecurityManager#checkWrite checkWrite(fileName)} denies write* access to the file** &＃64;throws UnsupportedEncodingException* If the named charset is not supported** &＃64;since 1.5*/public PrintStream(String fileName, String csn)throws FileNotFoundException, UnsupportedEncodingException{// ensure charset is checked before the file is openedthis(false, toCharset(csn), new FileOutputStream(fileName));}/*** Creates a new print stream, without automatic line flushing, with the* specified file. This convenience constructor creates the necessary* intermediate {&＃64;link java.io.OutputStreamWriter OutputStreamWriter},* which will encode characters using the {&＃64;linkplain* java.nio.charset.Charset#defaultCharset() default charset} for this* instance of the Java virtual machine.** &＃64;param file* The file to use as the destination of this print stream. If the* file exists, then it will be truncated to zero size; otherwise,* a new file will be created. The output will be written to the* file and is buffered.** &＃64;throws FileNotFoundException* If the given file object does not denote an existing, writable* regular file and a new regular file of that name cannot be* created, or if some other error occurs while opening or* creating the file** &＃64;throws SecurityException* If a security manager is present and {&＃64;link* SecurityManager#checkWrite checkWrite(file.getPath())}* denies write access to the file** &＃64;since 1.5*/public PrintStream(File file) throws FileNotFoundException {this(false, new FileOutputStream(file));}/*** Creates a new print stream, without automatic line flushing, with the* specified file and charset. This convenience constructor creates* the necessary intermediate {&＃64;link java.io.OutputStreamWriter* OutputStreamWriter}, which will encode characters using the provided* charset.** &＃64;param file* The file to use as the destination of this print stream. If the* file exists, then it will be truncated to zero size; otherwise,* a new file will be created. The output will be written to the* file and is buffered.** &＃64;param csn* The name of a supported {&＃64;linkplain java.nio.charset.Charset* charset}** &＃64;throws FileNotFoundException* If the given file object does not denote an existing, writable* regular file and a new regular file of that name cannot be* created, or if some other error occurs while opening or* creating the file** &＃64;throws SecurityException* If a security manager is present and {&＃64;link* SecurityManager#checkWrite checkWrite(file.getPath())}* denies write access to the file** &＃64;throws UnsupportedEncodingException* If the named charset is not supported** &＃64;since 1.5*/public PrintStream(File file, String csn)throws FileNotFoundException, UnsupportedEncodingException{// ensure charset is checked before the file is openedthis(false, toCharset(csn), new FileOutputStream(file));}/** Check to make sure that the stream has not been closed */private void ensureOpen() throws IOException {if (out &＃61;&＃61; null)throw new IOException("Stream closed");}/*** Flushes the stream. This is done by writing any buffered output bytes to* the underlying output stream and then flushing that stream.** &＃64;see java.io.OutputStream#flush()*/public void flush() {synchronized (this) {try {ensureOpen();out.flush();}catch (IOException x) {trouble &＃61; true;}}}private boolean closing &＃61; false; /* To avoid recursive closing *//*** Closes the stream. This is done by flushing the stream and then closing* the underlying output stream.** &＃64;see java.io.OutputStream#close()*/public void close() {synchronized (this) {if (! closing) {closing &＃61; true;try {textOut.close();out.close();}catch (IOException x) {trouble &＃61; true;}textOut &＃61; null;charOut &＃61; null;out &＃61; null;}}}/*** Flushes the stream and checks its error state. The internal error state* is set to true when the underlying output stream throws an* IOException other than InterruptedIOException,* and when the setError method is invoked. If an operation* on the underlying output stream throws an* InterruptedIOException, then the PrintStream* converts the exception back into an interrupt by doing:*

*     Thread.currentThread().interrupt();* 

*     out.format(format, args) 

*     out.format(l, format, args) 

*     out.print(csq.toString()) 

*     out.print(csq.subSequence(start, end).toString()) 

*     out.print(c) 

保存时注意保存为.java文件&＃xff0c;文件类型选择所有文件

 3》用cmd运行javadoc命令

javadoc -d "生成的文件名"  "目标文件" 

4》检查目录下是否生成printAPI文件

5》打开此文件

6》打开indexall文件

7》此时即可查看PrintStream API文档