eclipse中javadoc给项目生成api文档

摘要:
步骤1.打开java代码,编写JavaDoc注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号)。点击按钮6.选择使用的jdk版本点击按钮7.可以看到控制台输出生成javadoc的信息。

步骤

1.打开java代码,编写JavaDoc 注释,只有按照java的规范编写注释,才能很好的生成API文档,javadoc注释与普通注释的区别为多一个*(星号)。普通代码注释为/*XXX*/,而javadoc的注释为/**XXX*/

eclipse如何为java项目生成API文档、JavaDoc

2.javadoc注释要尽量写的详细,这样别人在没有源码的情况下才知道如何使用您的代码。

eclipse如何为java项目生成API文档、JavaDoc

3.点击eclipse的【Project】菜单,选择【Generate JavaDoc】选项。

eclipse如何为java项目生成API文档、JavaDoc

4.(1)选择您要生成JavaDoc的工程

(2)选择哪些级别的内容生成JavaDoc,默认为public,如果选择private则会全部内容都生成。

(3)选择doc的生成位置,默认为工程目录下,建议不要修改。

(5)点击【Next】按钮

eclipse如何为java项目生成API文档、JavaDoc

5.(1)勾选Document Title,然后填写文档标题。

(2)点击【Next】按钮

eclipse如何为java项目生成API文档、JavaDoc

6.

(1)选择使用的jdk版本

(2)点击【Finish】按钮

eclipse如何为java项目生成API文档、JavaDoc

7.

可以看到控制台输出生成javadoc的信息。

eclipse如何为java项目生成API文档、JavaDoc

8.

项目下生成一个【doc】的目录,里面存放着javadoc文档。

eclipse如何为java项目生成API文档、JavaDoc

9.

打开doc目录,用浏览器打开index.html

eclipse如何为java项目生成API文档、JavaDoc

注意点

有的时候生成的文档是中文乱码的,这个时候在第六步的时候需要加上-encoding UTF-8 -charset UTF-8

eclipse中javadoc给项目生成api文档第10张

免责声明:文章转载自《eclipse中javadoc给项目生成api文档》仅用于学习参考。如对内容有疑问,请及时联系本站处理。

上篇Android的移动存储解决方案之SharedPreferences 狼人:mysql binlog抽取某个表的数据下篇

宿迁高防,2C2G15M,22元/月;香港BGP,2C5G5M,25元/月 雨云优惠码:MjYwNzM=

相关文章

脚本_批量修改文件后缀名

#!bin/bash#功能:批量修改文件的后缀名,比如: 将.txt文件修改为.doc文件#作者:liusingbon#执行脚本时,需要在脚本名后面添加位置参数(文件后缀名)#例: 脚本名 txt doc (可以将以.txt结尾的文件修改为以.doc结尾)#例: 脚本名 doc jpg (可以将以.doc结尾的文件修改为以.jpg结尾)for i in "...

(转)Android Studio 增加函数注释模板

此篇文章主要介绍如何在Android Studio中函数如何添加注释,使其和eclipse一样方便的添加注释 Android Studio默认函数注释为 /** * */ 下面方法将要改为如下格式 1 2 3 4 5 /**  *  * @author zony  * @time 15-11-25 下午2:41  */...

关于MongoDB的group用法

之前在看Mongo的书时,看到了聚合这章。其中谈到了group这个功能,其实正如书中所说,MongoDB中的group和SQL中的group by是很相似的,但我自我分析,可能由于Mongo中的group的使用形式不同,而且使用的是js语法,所以导致咋一看上去不明白这个group怎么用。下面通过具体的一个例子来详细说明Mongo的group用法。 我们平常...

用python实现批量替换.doc文件文件内容

整个功能实现最重要的模块是docx这个模块 安装语句 pip install python-docx docx模块只能操作.docx文件,所以在这之前我们要将.doc文件转换成.docx。.doc文件是不能直接转换成.docx文件的,如果直接改后缀名会引起文件打不开或者乱码问题。 所以我们需要将文件另存为.docx格式。 import sys import...

C# FreeSpire.Doc 操作word文档

C# FreeSpire.Doc 免费的word文档类库 环境准备 Nuget安装 FreeSpire.Doc 引用 using Spire.Doc; using Spire.Doc.Documents; using System.IO; Html转换为word文档 static void GetHtmlDocument() {...

JAVA合并word文档生成目录

下载jar包,或者引入相关maven maven引入相关地址:https://www.e-iceblue.cn/licensing/install-spirepdf-for-java-from-maven-repository.html jar包下载地址:点击下载 如果不知道怎么引入jar包到项目中,请面向百度。 如果word文档中已经设置了大纲就直接使用...