java api接口文档怎么编写？

Python025

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   } }

这个首先你要确定一下短信平台，他们会给你提供短信实现的接口文档。

比如:

public static String doPost(String reqUrl, Map parameters, String recvEncoding)

{

HttpURLConnection url_con = null

String responseContent = null

try

{

StringBuffer params = new StringBuffer()

Iterator iter = parameters.entrySet().iterator()

while (iter

.hasNext())

{

Map.Entry element = (Map.Entry)iter.next()

params.append(element.getKey().toString())

params.append("=")

params.append(URLEncoder.encode(element.getValue().toString(),

requestEncoding))

params.append("&")

}

if (params.length() >0)

{

params = params.deleteCharAt(params.length() - 1)

}

URL url = new URL(reqUrl)

url_con = (HttpURLConnection)url.openConnection()

url_con.setRequestMethod("POST")

System.setProperty("sun.net.client.defaultConnectTimeout",

String.valueOf(connectTimeOut))

System.setProperty("sun.net.client.defaultReadTimeout",

String.valueOf(readTimeOut))

url_con.setDoOutput(true)

byte[] b = params.toString().getBytes()

url_con.getOutputStream().write(b, 0, b.length)

url_con.getOutputStream().flush()

url_con.getOutputStream().close()

InputStream in = url_con.getInputStream()

BufferedReader rd = new BufferedReader(

new InputStreamReader(in,

recvEncoding))

String tempLine = rd.readLine()

StringBuffer tempStr = new StringBuffer()

String crlf = System.getProperty("line.separator")

while (tempLine != null)

{

tempStr.append(tempLine)

tempStr.append(crlf)

tempLine = rd.readLine()

}

responseContent = tempStr.toString()

rd.close()

in.close()

}

catch (IOException localIOException)

{

}

finally

{

if (url_con != null)

{

url_con.disconnect()

}

}

return responseContent

}

public static String sendTelCode(String mobile,String telcode){

Map<String ,String>map = new HashMap<String ,String>()

map.put("account", "Babo")

map.put("mobile", mobile)

map.put("pswd", "D3dddD")

try {

map.put("msg", java.net.URLEncoder.encode("您的验证码是"+telcode+",若非本人操作请忽略","utf-8"))

} catch (UnsupportedEncodingException e) {

// TODO Auto-generated catch block

e.printStackTrace()

}

String getValue = doPost("http://www.ibabo.cn:7788/msg/HttpSendSM", map, "UTF-8")

System.out.println(getValue)

return getValue

}

1、直接用servlet就可以了，request．getInputStream（），然后解析xml，然后你的业务操作，组装XML，response．getOutputStream（）写出去就OK了4但这个性能低，而且还要依赖web容器imq2、socket实现http协议，把HTTP协议好好看看，自己解析（其实就是字符串的操作哦）。3、你要是只做客户端的话可以用httpClient284几行代码搞定了