自己总结的Javadoc编写规范.docVIP

JavaDoc编写示例 说明 1.在class的编写中,为了以后让自己或其它程序员能够熟练使用本类,而编写的文档信息. 2. 文档说明文件默认在 src/doc文件夹,文件名是 index.html,由myEclipse输出. 3.方法为myEclipse-file-export-javadoc-选择要输出的类文件,再选择protected(以便继承描述).其它默认. 4.在myEclipse里可以设置自动加载注释,myEclipse-windows-perferences-java-codeStyle-codeTemplates-comments下. 1.Files 文件头 2.Types 类定义 3.Fields 字段摘要(成员变量) 4.Constructors 构造函数 5.Methods 方法 6.Getters, 7.Setters 5.在myEclipse里输入/** 回车,就以快速弹出自定义的文档范例 6.输入 @ # ALT+/ 都可以快速弹出示例. myEclipse-windows-perferences-java-codeEditor-Templates 以下是class中件里的java文档示例 一.Files 文件头(写在文件最前方) myEclipse定义 /** * Description: br * * Copyright (c) 2013,ChongQing H3C Technologies Co.,Ltd.All rights reserved. * / * Author:杨易 QQ:804726030 Email:yangyiko@163.com * Since:${date} ${time} by:杨易 *//** * Description:数据库连接,操作,表信息查询 br需要sqljdbc4.jar驱动程序br * * Copyright (c) 2013,ChongQing H3C Technologies Co.,Ltd.All rights reserved. * / * Author:杨易 QQ:804726030 Email:yangyiko@163.com * Since:2013-4-18 下午12:08:41 by:杨易 */ 2.Types 类体(写在类定义的前方) 定义 /** * 功能简单说明. p * 例1: br * 例2: br * * @see [相关类/方法2] * @version version 2.1 * @since ${date} ${time} by:杨易 *//** * 数据库连接,操作,表信息查询br * 需要 sqljdbc4.jar驱动程序. p * 例1: ConnectionDatabase(,1433,yydb,sa,097040);br * 例2: ConnectionDatabase(databaseName) ip地址,端口号,用户名,密码都可以默认;br * 对数据库进行连接br * 可以得到该数据库表格信息(表格名称,字段信息,字段类型)br * 可以对数据库进行DML,DQL,DDL操作 br * * @see ConnectionDatabase#getTableNames() getTableNames 得到当前数据库所有表格名称 * @see ConnectionDatabase#getTableFiledNames() getTableFiledNames 得到字段名称 * @see ConnectionDatabase#getTableFiledTypes() getTableFiledTypes 得到字段类型 * @see ConnectionDatabase#DML(String) DML 数据库管理语言 insert,update,delete * @see ConnectionDatabase#DQL(String) DQL 数据库查询语言 query * @see ConnectionDatabase#DQL(String, String[]) DQL 数据库查询语言(注入式) query * @see ConnectionDatabase#DDL(String) DDL 数据库定义语言 create,drop,alter * @since : 2013-4-18 下午3:03:41 by 杨易 * */　/**男性，值为{@value}*/?　public static final int MALE = 1;/** * 功能简单说明.pbr * 例: br * * @param [