Eclipse自动生成javadoc

最新推荐文章于 2023-08-28 22:49:28 发布

Andrew659

最新推荐文章于 2023-08-28 22:49:28 发布

阅读量2.9k

点赞数

分类专栏： Java 文章标签： javadoc eclipse applet documentation comments file

本文链接：https://blog.csdn.net/Andrew659/article/details/6112982

版权

Java 专栏收录该内容

34 篇文章 0 订阅

订阅专栏

javadoc

The JDK tool that generates API documentation from documentation comments.

Documentation comments (doc comments)

The special comments in the Java source code that are delimited by the /** ... */ delimiters. These comments are processed by the Javadoc tool to generate the API docs.

How to write Java doc comments

http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

选中某个project, 然后菜单 > project > generate javadoc

(Eclipse有个Jautodoc pulgin 可以为每个文件自动生成comment)

Package Comment Files

Each package can have its own documentation comment, contained in its own "source" file, that the Javadoc tool will merge into the package summary page that it generates. You typically include in this comment any documentation that applies to the entire package.

To create a package comment file, you have a choice of two files to place your comments:

package-info.java - Can contain a package declaration, package annotations, package comments and Javadoc tags. This file is new in JDK 5.0, and is preferred over package.html.
package.html - Can contain only package comments and Javadoc tags, no package annotations.

A package may have a single package.html file or a single package-info.java file but not both. Place either file in the package directory in the source tree along with your .java files.

package-info.java This file can contain a package comment of the following structure -- the comment is placed before the package declaration:

File: java/applet/package-info.java

     
     
      
      /**
      
      








      
      







 * Provides the classes necessary to create an applet and the classes an applet uses 
      
      








      
      







 * to communicate with its applet context. 
      
      








      
      







 * <p>
      
      








      
      







 * The applet framework involves two entities: 
      
      








      
      







 * the applet and the applet context. An applet is an embeddable window (see the 
      
      








      
      







 * {@link java.awt.Panel} class) with a few extra methods that the applet context 
      
      








      
      







 * can use to initialize, start, and stop the applet.
      
      








      
      







 *
      
      








      
      







 * @since 1.0
      
      








      
      







 * @see java.awt
      
      








      
      







 */
      
      








      
      







package java.lang.applet;

Note that while the comment separators /** and /* must be present, the leading asterisks on the intermediate lines can be omitted. package.html - This file can contain a package comment of the following structure -- the comment is placed in the <body> element:

File: java/applet/package.html

 
 
  
  <HTML>
  
  








  
  







<BODY>
  
  








  
  







Provides the classes necessary to create an applet and the classes an applet uses 
  
  








  
  







to communicate with its applet context. 
  
  








  
  







<p>
  
  








  
  







The applet framework involves two entities: 
  
  








  
  







the applet and the applet context. An applet is an embeddable window (see the 
  
  








  
  







{@link java.awt.Panel} class) with a few extra methods that the applet context 
  
  








  
  







can use to initialize, start, and stop the applet.
  
  








  
  








  
  








  
  







@since 1.0
  
  








  
  







@see java.awt
  
  








  
  







</BODY>
  
  








  
  







</HTML>

Andrew659

关注

0
点赞
踩
0

收藏

觉得还不错? 一键收藏
0
评论
Eclipse自动生成javadoc

选中某个project, 然后菜单 > project > generate javadoc(Eclipse有个Jautodoc pulgin 可以为每个文件自动生成comment)Package Comment Files Each package can have its own documentation comment, contained in its own "source" file, that the Javadoc tool will merge into the pa
复制链接

扫一扫