作为Java程序员,使用开源的软件,自然也应该让自己的代码开源,至少提供API——
1.新建名称为Console.java的源文件,并在代码中添加注释(普通注释不会出现在API中):
-
/**
-
* 这是文档注释
-
*/
-
public class Console {
-
/**
-
* main函数注释
-
*/
-
public static void main(String[] args) {
-
// 普通单行注释
-
/*
-
* 普通多行注释
-
*/
-
System.out.println("these code is for creating the javadoc ");
-
}
-
-
}
2.打开dos窗口,将路径设置到Console.java所在目录,使用dos命令:
javadoc Console.java
3.dos窗口会显示处理过程
4.在源代码所在文件夹会生成许多HTML文件,其中index.html文件为入口文件。
阅读(483) | 评论(0) | 转发(0) |