jar包添加java注释文档.docVIP

Android设置外源JAR包的说明文档 将已有项目注释 1 注释文档的格式 /view/975838.htm 1.2 注释文档将用来生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。 例如： /** * The doGet method of the servlet. * This method is called when a form has its tag value method equals to get. * @param request * the request send by the client to the server * @param response * the response send by the server to the client * @throws ServletException * if an error occurred * @throws IOException * if an error occurred */ public void doGet (HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException { doPost(request, response); } 前两行为描述，描述完毕后，由@符号起头为块标记。 注释的种类 2.1 文件头注释文件头注释以 /*开始，以*/结束，需要注明该文件创建时间，文件名，命名空间信息。 例如： /* * Created on 2005-7-2 * / 2.2 类、接口注释类、接口的注释采用 /** … */，描述部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。 2.3 构造函数注释构造函数注释采用 /** … */，描述部分注明构造函数的作用，不一定有块标记部分。 例如： /** * 默认构造函数 */ 例如： /** * 带参数构造函数,初始化模式名,名称和数据源类型 * @param schema * Ref 模式名 * @param name * Ref 名称 * @param type * byVal 数据源类型 */ 2.4 域注释域注释可以出现在注释文档里面，也可以不出现在注释文档里面。用/** … */的域注释将会被认为是注释文档热出现在最终生成的HTML报告里面，而使用/* … */的注释会被忽略。 例如： /** * The X-coordinate of the component. * * @see #getLocation() */ int x = 1263732; 2.5 方法注释方法注释采用 /** … */，描述部分注明方法的功能，块标记部分注明方法的参数，返回值，异常等信息。例如： /** * 设置是否有外码约束 * * @param conn * Connection 与数据库的连接 */ 2.6 定义注释规则同域注释。 将带注释的项目生成javadoc 步骤 （1）在eclipse左侧工程列表中右键选中项目，选中Export,在其列表中点击Java--Javadoc，如图，选中后点击NEXT 进入下一页后，进行如下设置 点击Next进入下一页，有需要的可以自行修改，没有的话点击下一页，在页面中进行中文注释的乱码处理，如图 然后点击finished，会生成完成，完成后可以进入工程目录下的doc文件夹内进行查询，特别注意，当你的文档注释有错时，会在Concle下显示你的错误，错误严重的时候会不能生成javadoc，会在ddms下报错，自行查看。 你可以查询你的错误，然后去doc目录下的项目文件夹class-use下相应的文件进行修改 需说明，是HTML的格式。 个人建议：找到错误去项目中修改原文件，然后清除doc文件夹下的内容重新进行生成，毕竟后期要做成jar包调用。 将项目打包成jar包 步骤 在eclipse左侧工程列表中右键选中项目，选中Export,在其列表中点击Java----JAR file，如图，选中后点击NEXT 进入下一页后，进行如下设置，只保留你必要的文件，冗余的都去掉，不然后期JAR包调用速度会很慢，版本低还会报错，JAR file里填写你生成的jar包名称，然后选择你存放的路径，不能存放在当前默认项目下 点击2次next，进入最后一页选择你程序的主入口，确认后点击完成，JAR包就生成完成。 需注意：当你想生成的程序自引用了其他包时需保留LIB文件夹，更多注意请参考/Mr-Hannibal/archive/2012/05/18/250805