jar包添加javadoc注释文档.docVIP

Android设置外源JAR包的说明文档 将已有项目注释 1 注释文档的格式 1.1 javadoc 文档注视中用到的(前面加@符号) author 作者名 version 标明该类模块的版本 4.0 parameter 对方法中某参数的说明 since 最早使用该方法/类/接口的JDK版本 return 对方法返回值的说明 throws 异常类及抛出条件 deprecated 引起不推荐使用的警告 see reference 参考转向，也就是相关主题 override 重写 当前用到的只有这些，更多请参考HYPERLINK /view/975838.htm/view/975838.htm 1.2 注释文档将用来生成HTML格式的代码报告，所以注释文档必须书写在类、域、构造函数、方法、定义之前。注释文档由两部分组成——描述、块标记。 需注意：写在目标之后的将无法自动生成对应的JAVADOC文件，即生成时报错。 例如： /** * 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 注释的种类 2.1 文件头注释文件头注释以 /*开始，以*/结束，需要注明该文件创建时间，文件名，命名空间信息。 例如： /* * Created on 2005-7-2 * / 2.2 类、接口注释类、接口的注释采用 /** … */，描述部分用来书写该类的作用或者相关信息，块标记部分必须注明作者和版本。 说明：公司的格式化规范里有这个，导入前可以自己修改作者名及当前版本号 /** * com.example.androidjavadocexample.MainActivity * @author xiasiming br/ * @version Version 1.00 br/ * create at 2012-11-9 上午11:04:03 */ 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 定义注释规则同域注释。 3注释块标记 3.1 标记的顺序块标记将采用如下顺序： … * * @param (classes, interfaces, methods and constructors only) * @return (methods only) * @exception (@throws is a synonym added in Javadoc 1.2) * @author (classes and interfaces only