黑马程序员技术交流社区

标题: 怎么使用java API文档 ..标题要长长长长长长长长长长长长长长长长长长长长长 [打印本页]
作者: 张栋    时间: 2013-4-7 15:35
标题: 怎么使用java API文档 ..标题要长长长长长长长长长长长长长长长长长长长长长
本帖最后由 张栋 于 2013-4-8 00:23 编辑

我是新手,不可能像老师那样,把所有常用的都记下来,也不知道那些常用.所以在查API的时候搞不明白,怎么根据API去敲代码,怎么看格式.
求 教..............................
谢谢
作者: 随便    时间: 2013-4-7 16:13
本帖最后由 邓宫财 于 2013-4-7 16:15 编辑

这个不知道怎么教，不过问一下你能写出一个完整的类不？
能的话把你的类全部加上注释，然后用javadoc编译成文档，如果那个文档别人能看得懂，你就能看懂api文档了。
例如String类。
  1. /**
  2. * 自定义的字符串类，
  3. * @author Dgc
  4. *
  5. */
  6. public class MyString {
  7.         private StringBuffer sb = null;
  8.         
  9.         /**
  10.          * 用一个字符串构造一个MyString的对象
  11.          * @param str 一个 String
  12.          */
  13.         public MyString(String str) {
  14.                 sb = new StringBuffer(str);
  15.         }

  17.         /**
  18.          * 返回指定索引处的 char 值。索引范围为从 0 到 length() - 1。序列的第一个 char 值位于索引 0 处，第二个位于索引 1 处，依此类推，这类似于数组索引。
  19.          * @param index char的索引值
  20.          * @return 此字符串指定索引处的 char 值。第一个 char 值位于索引 0 处。
  21.          */
  22.         public char charAt(int index){
  23.                 if(index < 0 || index > sb.length())
  24.                         throw new IndexOutOfBoundsException("角标越界");
  25.                 return sb.charAt(index);
  26.         }
  27. }
复制代码
使用javadoc编译出文档
作者: 王大伟    时间: 2013-4-7 16:15
首先你要知道你要查的是什么API

比如,你要查一个方法replace(),你先要知道是那个类的方法,这里你知道是String类里的方法后,你再API去找String这个类,然后再查replace就找到了.

API 文档仅仅是查询类、方法的功能、参数的（前提是对这些类有初步的认识），并不能教你怎样去使用 Java 做东西的。
API 的作用主要在于你的某些类有了些初步的了解之后，再想更深入一步的情况下使用的，否则要看的就不是 API，而是一些 Java 程序设计方面的书籍。

API 中都有一个 index-files 的索引，可以根据首字母来查询方法。
作者: 小黑黑    时间: 2013-4-7 19:36
其实最简单的方法就是按照上面的方法敲代码，尝试是最好的老师之一。
1、比如，你查到了String类的一个方法是trim()，String的API文档上解释为：返回字符串的副本，忽略前导空白和尾部空白。假如说这这很难理解，最好的办法就是试着敲代码，查看结果。
2、点开这个方法后，里面说明是：此方法可用于截去字符串开头和末尾的空白。那么这里就涉及到了字符串开头或结尾的空白；
3、且这个方法没有static，那么就是非静态的，所以就需要创建一个对象，比如：String str = "    abc   "；
4、再调用这个方法：str.trim();；它的返回的类型是String，那么就可定义一个变量接收结果：String newStr = str.trim();
5、最后打印System.out.println(newStr);结果为abc，那么就知道了这个是去除开头或结尾含有空格的字符串的方法。
作者: 黄玉昆    时间: 2013-4-7 19:38
如果问题未解决，请继续追问，如果没有问题了，请将帖子分类 改为“已解决”，谢谢
作者: 李大伟    时间: 2013-4-7 21:27
首先应该 搞个大概 知道哪个 类 去哪个包里找，另外还可以搜索 ，点左上角的显示，里边搜索你需要的，然后可以知道它属于哪个包，哪个类
知道 包和类后，找到这个类，比如 String 可以先点java.lang，找到String类，点一下
下边是一大堆说明的东西，给你举个例子啊，告诉你实现哪个接口什么的
在下边就是构造函数了，
构造函数 就是重载，比如String
String()
String(byte[] bytes)
String(StringBuffer buffer)
String(StringBuilder builder)等等 这些 根据传的参数决定

下边就是方法摘要了，就是比如
String str = "abc";
str. 什么什么 ，这些可以直接点一下，看看怎么用
大概就是这样了，我也是新手，理解有限，抛砖引玉吧！

作者: 张栋    时间: 2013-4-8 00:15
邓宫财 发表于 2013-4-7 16:13
这个不知道怎么教，不过问一下你能写出一个完整的类不？
能的话把你的类全部加上注释，然后用javadoc编译成 ...

谢谢你。
作者: 张栋    时间: 2013-4-8 00:16
王大伟 发表于 2013-4-7 16:15
首先你要知道你要查的是什么API

比如,你要查一个方法replace(),你先要知道是那个类的方法,这里你知道是Str ...

学习了。谢谢你。
作者: 张栋    时间: 2013-4-8 00:18
小黑黑 发表于 2013-4-7 19:36
其实最简单的方法就是按照上面的方法敲代码，尝试是最好的老师之一。
1、比如，你查到了String类的一个方法 ...

你的方法应该还不错。谢谢你。学习了。
作者: 张栋    时间: 2013-4-8 00:19
李大伟 发表于 2013-4-7 21:27
首先应该 搞个大概 知道哪个 类 去哪个包里找，另外还可以搜索 ，点左上角的显示，里边搜索你需要的，然后 ...

新手都不容易啊。还是谢谢你。
作者: 张栋    时间: 2013-4-8 00:32
黄玉昆 发表于 2013-4-7 19:38
如果问题未解决，请继续追问，如果没有问题了，请将帖子分类 改为“已解决”，谢谢 ...

已经解决了。谢谢。



欢迎光临 黑马程序员技术交流社区 (http://bbs.itheima.com/) 黑马程序员IT技术论坛 X3.2