[size=medium]原出处:[url]http://shenzhenchufa.blog.51cto.com/730213/245686[/url]
如何快速熟悉一个开源软件:
1 到其官网下载此软件的原理介绍文件,开发者说明文档及java doc(java doc文档若不存在,可自己生成)文档—建立大体概念,易忽略。
2 走读源码:
2.1 下载源码,将源码在eclipse中跑起来,用debug方法跑一遍,结合上面下载文档,了解流程细节。—理解具体细节。
2.2 走读java文件:看类,方法的注释及out-line的类结构图,便可大致了解类。注意:走读源码,并不是要将软件的每一个类从头到尾看一遍,即使看了,也不会清晰系统的运行流程。
2.3 将上面两步中理解的系统运行流程,用时序图表示出来。(刚刚理解的运行流程,可能到明天就模糊了,画在图上,方便以后快速了解软件的流程)
Java doc简介:
Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形式程序的开发文档了。
作用:
可以把源码中注释都提取出来,直接看javadoc的文档:可以看到类及类结构关系
命令:javadoc *.java
作用:对当前路径下所有的java文件生成帮助文档,生成出来的格式和英文帮助文档一样,不过你需要添加足够的文档注释,就是/** */的内容,你可以尝试编译下面的代码 Demo.java
/**
*demo program
*/
public class Demo{
/**
*程序唯一的成员常量
*/
public static final PI=3.14;
/**
*程序唯一的方法
*/
public void doThisProgram{
}
}
使用:
Eclipse的Javadoc功能,直接点击项目,右键导出,选择java,javadoc,然后使用具体的项目中须导出的文件。
其中,提示输入javadoc command的时候,我一直以为是要输入javadoc在命令行下的什么命令,后来才发现,是需要指出javadoc.exe文件的位置(这个文件在你的jdk的安装目录下的bin文件夹下)。
然后还有可能出的错误是,outofmemory,这时候,你可以在java虚拟机的选项里加上一句:
-J-Xmx512m。这里的512是我自己写的。你可以根据实际情况改一下。最后就可以生成源码的doc文档了。[/size]
如何快速熟悉一个开源软件:
1 到其官网下载此软件的原理介绍文件,开发者说明文档及java doc(java doc文档若不存在,可自己生成)文档—建立大体概念,易忽略。
2 走读源码:
2.1 下载源码,将源码在eclipse中跑起来,用debug方法跑一遍,结合上面下载文档,了解流程细节。—理解具体细节。
2.2 走读java文件:看类,方法的注释及out-line的类结构图,便可大致了解类。注意:走读源码,并不是要将软件的每一个类从头到尾看一遍,即使看了,也不会清晰系统的运行流程。
2.3 将上面两步中理解的系统运行流程,用时序图表示出来。(刚刚理解的运行流程,可能到明天就模糊了,画在图上,方便以后快速了解软件的流程)
Java doc简介:
Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类、方法、成员等注释形成一个和源代码配套的API帮助文档。也就是说,只要在编写程序时以一套特定的标签作注释,在程序编写完成后,通过Javadoc就可以同时形式程序的开发文档了。
作用:
可以把源码中注释都提取出来,直接看javadoc的文档:可以看到类及类结构关系
命令:javadoc *.java
作用:对当前路径下所有的java文件生成帮助文档,生成出来的格式和英文帮助文档一样,不过你需要添加足够的文档注释,就是/** */的内容,你可以尝试编译下面的代码 Demo.java
/**
*demo program
*/
public class Demo{
/**
*程序唯一的成员常量
*/
public static final PI=3.14;
/**
*程序唯一的方法
*/
public void doThisProgram{
}
}
使用:
Eclipse的Javadoc功能,直接点击项目,右键导出,选择java,javadoc,然后使用具体的项目中须导出的文件。
其中,提示输入javadoc command的时候,我一直以为是要输入javadoc在命令行下的什么命令,后来才发现,是需要指出javadoc.exe文件的位置(这个文件在你的jdk的安装目录下的bin文件夹下)。
然后还有可能出的错误是,outofmemory,这时候,你可以在java虚拟机的选项里加上一句:
-J-Xmx512m。这里的512是我自己写的。你可以根据实际情况改一下。最后就可以生成源码的doc文档了。[/size]