java api接口文档怎么编写?

java api接口文档怎么编写?,第1张

Java语言提供了一种强大的注释形式:文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释,然后使用javadoc工具来生成自己的API文档。

文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。

自行搜索一下javadoc即可,示例如下:

1234567891011121314151617181920212223242526272829/** * 类描述 * * @author 作者 * @version 版本 */public class DemoClass {    /**     * 内部属性:name     */    private String name          /**     * Setter方法     * @return name     */    public String getName() {        return name   }     /**     * Getter方法     * @param name     */    public void setName(String name) {        this.name = name   } }

java提供webservice接口

java提供普通的访问接口(其他程序调用)

比如天气预报写个接口

public String getWeather(int type){ //type表示城市ID,这样

  return  "天气信息"

}

别人就可以访问getWeather这个接口获取天气信息

java发一个http请求过去,带上参数就可以了啊,跟我们在浏览器上访问资源是一样的 只是它返回的是json格式的数据而已

给你两个方法吧:

public static String do_post(String url, List<NameValuePair>name_value_pair) throws IOException {

String body = "{}"

DefaultHttpClient httpclient = new DefaultHttpClient()

try {

HttpPost httpost = new HttpPost(url)

httpost.setEntity(new UrlEncodedFormEntity(name_value_pair, StandardCharsets.UTF_8))

HttpResponse response = httpclient.execute(httpost)

HttpEntity entity = response.getEntity()

body = EntityUtils.toString(entity)

} finally {

httpclient.getConnectionManager().shutdown()

}

return body

}

public static String do_get(String url) throws ClientProtocolException, IOException {

String body = "{}"

DefaultHttpClient httpclient = new DefaultHttpClient()

try {

HttpGet httpget = new HttpGet(url)

HttpResponse response = httpclient.execute(httpget)

HttpEntity entity = response.getEntity()

body = EntityUtils.toString(entity)

} finally {

httpclient.getConnectionManager().shutdown()

}

return body

}


欢迎分享,转载请注明来源:内存溢出

原文地址: http://outofmemory.cn/sjk/6857734.html

(0)
打赏 微信扫一扫 微信扫一扫 支付宝扫一扫 支付宝扫一扫
上一篇 2023-03-29
下一篇 2023-03-29

发表评论

登录后才能评论

评论列表(0条)

保存