api开发文档怎么写( 二 ) _文档

下面开始按照文档的目录结构逐一进行详细的介绍说明，比如文档说明的介绍，用高效简洁的语言明确的说明文档信息，注意文档中大标题应当字体大小样式一致，小标题也应当字体大小注意保持一致。
简单的说明技术资料获取及准备，确认调用系统信息比较重要，需要确认编码格式，防止乱码，确认当前的文档版本是否是要使用的版本，否则白做无用功，项目的搭建环境简单说明即可。
开始说明接口的调用流程，如何调用接口，需要做的一些准备，说明引入相应的依赖以及配置需要配置的文件。
现在可以开始接口的说明，接口的说明信息应当包含接口的名称，接口的地址，接口的协议，然后针对当前接口下的方法说明。
方法的说明应当包含方法的描述，即其作用，方法的请求参数说明，以及响应的参数说明，参数说明应当包含参数的类型，参数名称，参数的含义，并且备注参数是否必须传递。
9
接口说明完之后，就是文档的末尾，有注意事项添加一些注意事项，或者附录说明，添加标注。
5.什么是API文档【2006-02-08 13:54】【】【SUN】 Sun 公司提供的Java API Docs是学习和使用Java语言中最经常使用的参考资料之一。但是长期以来此文档只有英文版，对于中国地区的Java开发者来说相当的不便。目前Sun 公司正在组织多方力量将此文档翻译成中文，并于近日在Sun 中国技术社区（.cn/）正式发布java.lang和java.util类库API 文档的中文版，其他类库API文档的中文版也将于今后一段时间内陆续向中国地区的开发人员提供。在J2SE API文档（5.0版本）的汉化工作完成之后，Sun 中国技术社区还将开通Java API 文档中文版的打包下载服务。
Java API 文档中文版发布计划
发布时间相关类库阅读/下载
2005/10/31 java.lang
java.util 在线阅读
2005/12/31 java.awt
java.io
java.text 在线阅读
2006/02/28 javax.swing 在线阅读
2006/03/31 java.applet
java.beans
java.maths
java.net
java.nio
java.rmi
java.security
java.sql
javax.accessibility
javax.activity
javax.crypto
2006/04/30 javax.imageio
javax.management
javax.net
javax.naming
javax.print
javax.rmi
javax.security
javax.sound
2006/05/31 javax.sql
javax.transaction
javax.xml
org.ietf
org.xml
org.w3c
org.omg
原文地址：.cn/chinese_java

文章插图