androidapi开发文档（android studio怎么生成api文档）

本文目录

• android studio怎么生成api文档
• android sdk api文档在哪
• android api文档（/docs/index.html）中不能搜索
• 如何查看android api
• 最新的API文档怎么下
• 如何查看Android SDK API文档
• android SDK 文档目录下都有哪些文件都代表着什么
• Android APP开发需求文档范本

android studio怎么生成api文档

在Android studio中进行打开一个项目的文件之后，然后进行点击Android stuio中菜单中的“tools”的选项。
这样就会弹出了下拉菜单中，进行选中下拉菜单中的“generate javadoc”的选项。
就会弹出了specify generate javadoc scope的窗口，在output directorys中进行输出的路径。
可在运行的窗口中查看到的是文件正在生成，根据文件大小，对生成的时间上等待。
文件生成完毕之后，进入到了resource的文件，进行双击index.html的选项即可。
这样就同index.html中查看代码中所有类的方法，如果有添加注释的信息，也可查看到。

android sdk api文档在哪

默认在Android SDK安装目录的docs\reference\packages.html下。下面是Android的sdk、api及工程目录说明：
SDK下包的说明：
1：add-***：Android开发需要的第三方文件和软件库
2：docs：Android的文档。包括开发指南、API参考、资源等
3：extras：扩展的附加包
4：platforms：你安装下载的所有Android平台，分版本存放
5：platform-tools：平台相关的工具
6：samples：所有的样例程序
7：system-images：系统使用的图片
8：temp：临时操作或缓存的目录
9：tools：应用Android平台进行开发所需要的一些开发工具
常见的api包说明：
1：android.app ：提供高层的程序模型、提供基本的运行环境
2：android.content ：包含各种的对设备上的数据进行访问和发布的类
3：android.database ：通过内容提供者浏览和操作数据库
4：android.graphics ：底层的图形库，包含画布，颜色过滤，点，矩形，可以将他们
直接绘制到屏幕上.
5：android.location ：定位和相关服务的类
6：android.media ：提供一些类管理多种音频、视频的媒体接口
7：android.net ：提供帮助网络访问的类，超过通常的java.net.* 接口
8：android.os ：提供了系统服务、消息传输、IPC 机制
9：android.opengl ：提供OpenGL 的工具
10：android.provider ：提供类访问Android 的内容提供者
11：android.telephony ：提供与拨打电话相关的API 交互
12：android.view ：提供基础的用户界面接口框架
13：android.util ：涉及工具性的方法，例如时间日期的操作
14：android.webkit ：默认浏览器操作接口
15：android.widget ：包含各种UI 元素（大部分是可见的）在应用程序的屏幕中使用

android api文档（/docs/index.html）中不能搜索

直接把自己在知乎的回答过得拷贝过来，希望对大家有作用。

一、原因

不能索索的根本原因是浏览器无法访问Google，服务器无法响应里面的Ajax。

二、解决办法

方法1：使用Mozilla Firefox浏览器，点击“文件”选择“脱机模式”，然后在浏览器里面输入android sdk的docs路径，比如：file:///E:/androidstudio/sdk/docs/reference/packages.html 。 然后再去搜索的时候就可以了。（注：Google浏览器不行）

方法2：将docs文件放到tomcat里面，然后运行tomcat，再通过localhost访问文档。这种方式还是有点慢，推荐第一种。

如何查看android api

有两种方法：

方法一：

打开下载的SDK目录 -》 docs -》 index.html，查看里面的API文档。

方法二：

进谷歌的官网，它的首页靠右上角的部位有个搜索框，只要输入想要查询的控件或者接口，选择并跳转以后，左边一小块是api的总体结构，右边的大部分内容就是需要慢慢看的东西了，最上面有介绍它的父类是什么，还可以追溯到最上层的Object类，下面有简介、构造方法、属性、public方法、protected方法还有一些xml的属性和常量值。

例如：

其实API的使用是比较简单的，就是不停的查找，查参数，查返回值。

最新的API文档怎么下

在AS中我们可以简单查看函数或类的API，选中我们想要查看的函数或类的代码，按快捷键 Ctrl+Q，AS就会弹出一个简单说明的窗口： 

但一般我们的是这样： 

那是因为AS去访问Google的网站了，然后就gg了 ╮(╯▽╰)╭ 。我们可以FQ来解决这个问题，或者用下面的方法。

第一步：下载Android API的文档

API下载好后位于AndroidSDK的docs目录下，有一个G大小。

第二步：设置路径

修改 C:\Users\Administrator.AndroidStudio2.2\config\opti*** 路径下的 jdk.table.xml 文件，找到如下位置（根据你安装的API版本数可能有多处位置，最好都修改了）:

***隐藏网址***

将标签中的url地址改为自己PC上下载好的API目录，定位到docs中的reference目录，如下：

《javadocPath》    《root type="composite"》        《root type="******" url="file://C:/StudyProgram/android/android_SDK/docs/reference" /》    《/root》《/javadocPath》

保存重启AS即可。

详细查看API

直接查看我们下载好的API文档即可，只查看API的话建议直接打开这个文件：AndroidSDK/docs/reference/classes.html ，由于这些API文档中的 js 有时还是会访问Google网站，所以有时会很卡。。可以试试以下方法：

方法一

找个梯子。。

方法二

听说火狐浏览器有脱机运行模式，好像Chrome也可以。。

方法三

修改hosts把一些指向Google的网站指向到本地（此法慎用）：

***隐藏网址***

如何查看Android SDK API文档

查看android api有两种方式：在线查看与离线查看。

1.  在线查看

在线查看一般是指在安卓开发者官网上直接查看，但这需要你的网络环境可以访问谷歌。

官方地址如下：

***隐藏网址***

目前最新的API是android 24，如下图，左边可以切换API的版本，右边可以切换显示包索引还是类索引。

2.  离线查看

离线查看一般是指在SDK Manager里下载开发者帮助文档如下图（最新的是Android 7，即API 24）：

下载完成后，会显示Install状态。然后，进入SDK安装目录，打开名为docs的文件夹，接着在浏览器中打开index.html文件，这时可以在页面左边看到如下图的索引：

依次打开Develop--》Reference，然后就可以看到API文档了。这个docs几乎包含了开发者官网的全部内容，所以除了查看API，还可以查看官方教程等资源。

另外，虽说这是离线文档，但里面包含了谷歌字体服务和几个连接谷歌的脚本，所以打开时可能会很慢。解决方案是用一个器比如Notepad++，搜索各文件中包含的访问谷歌服务的网址字串，并将其替换为空串就可以了。

android SDK 文档目录下都有哪些文件都代表着什么

Android SDK 目录下有很多文件夹，主要都是干什么的呢?
1. add-*** 这里面保存着附加库，比如google Maps，当然你如果安装了OPhone SDK，这里也会有一些类库在里面。
2. docs 这里面是Android SDK API参考文档，所有的API都可以在这里查到。
3. market_licensing 作为Android Market版权保护组件，一般发布付费应用到电子市场可以用它来反盗版。
4. platforms 是每个平台的SDK真正的文件，里面会根据API Level划分的SDK版本， 这里就以Android 2.2来说，进入后有一个android-8的文件夹，android-8进入后是Android 2.2 SDK的主要文件，其中ant为ant编译脚本，data保存着一些系统资源，images是模拟器映像文件，skins则是Android模拟器的皮肤，templates是工程创建的默认模板，android.jar则是该版本的主要framework文件，tools目录里面包含了重要的编译工具，比如aapt、aidl、逆向调试工具dexdump和编译脚本dx。
5. platform-tools 保存着一些通用工具，比如adb、和aapt、aidl、dx等文件，Android123提示，这里和platforms目录中tools文件夹有些重复，主要是从android 2.3开始这些工具被划分为通用了。
6. samples 是Android SDK自带的默认示例工程，里面的apidemos强烈推荐初学者运行学习，对于**Lite数据库操作可以查看NotePad这个例子，对于游戏开发 Snake、LunarLander都是不错的例子，对于Android主题开发Home则是android m5时代的主题设计原理。
7. tools 作为SDK根目录下的tools文件夹，这里包含了重要的工具，比如ddms用于启动Android调试工具，比如logcat、屏幕截图和文件管理器，而draw9patch则是绘制android平台的可缩放png图片的工具，sqlite3可以在PC上操作**Lite数据库，而 monkeyrunner则是一个不错的压力测试应用，模拟用户随机按键，mksdcard则是模拟器SD映像的创建工具，emulator是android模拟器主程序，不过从android 1.5开始，需要输入合适的参数才能启动模拟器，traceview作为android平台上重要的调试工具。
8. u**_driver 顾名思义，保存着android平台google官方机型的驱动如nexus one、nexus s，同时也有一些老机型驱动的支持，比如说htc dream、htc magic和Motorola 的droid。
参考自：blog.csdn.net/coolwzjcool/article/details/7761663

Android APP开发需求文档范本

软件需求文档格式的标准写法
1．引言

1．1 编写目的

· 阐明开发本软件的目的；

1．2 项目背景

· 标识待开发软件产品的名称、代码；

· 列出本项目的任务提出者、项目负责人、系统分析员、系统设计员、程序设计员、程序员、资料员以及与本项目开展工作直接有关的人员和用户；

· 说明该软件产品与其他有关软件产品的相互关系。

1．3 术语说明

列出本文档中所用到的专门术语的定义和英文缩写词的原文。

1．4 参考资料（可有可无）

列举编写软件需求规格说明时所参考的资料，包括项目经核准的计划任务书、合

同、引用的标准和规范、项目开发计划、需求规格说明、使用实例文档，以及相关产品

的软件需求规格说明。

在这里应该给出详细的信息，包括标题、作者、版本号、发表日期、出版单位或资

料来源。

2．项目概述

2．1 待开发软件的一般描述

描述待开发软件的背景，所应达到的目标，以及市场前景等。

2．2 待开发软件的功能

简述待开发软件所具有的主要功能。为了帮助每个读者易于理解，可以使用列表或

图形的方法进行描述。使用图形表示，可以采用：

· 顶层数据流图；

· 用例UseCase图；

· 系统流程图；

· 层次方框图。

2．3 用户特征和水平（是哪类人使用）

描述最终用户应具有的受教育水平、工作经验及技术专长。

2．4 运行环境

描述软件的运行环境，包括硬件平台、硬件要求、操作系统和版本，以及其他的软

件或与其共存的应用程序等。

2．5 条件与限制

给出影响开发人员在设计软件时的约束条款，例如：

· 必须使用或避免使用的特定技术、工具、编程语言和数据库；

· 硬件限制；

· 所要求的开发规范或标准。

3．功能需求

3．1 功能划分

列举出所开发的软件能实现的全部功能，可采用文字、图表或数学公式等多种方法

进行描述。

3．2 功能描述

对各个功能进行详细的描述。

4．外部接口需求

4．1 用户界面

对用户希望该软件所具有的界面特征进行描述。以下是可能要包括的一些特征：

· 将要采用的图形用户界面标准或产品系列的风格；

· 屏幕布局；

· 菜单布局；

· 输入输出格式；

· 错误信息显示格式；

建议采用RAD开发工具， 比如Visio，构造用户界面。

4．2 硬件接口

描述系统中软件产品和硬件设备每一接口的特征，以及硬件接口支持的设备、软件与硬件接口之间，以及硬件接口与支持设备之间的约定，包括交流的数据和控制信息的性质以及所使用的通信协议。

4．3 软件接口

描述该软件产品与其有关软件的接口关系，并指出这些外部软件或组件的名字和版本号。比如运行在什么操作系统上，访问何种类型的数据库，使用什么数据库连接组件，和什么商业软件共享数据等。

4．4 通信接口

描述和本软件产品相关的各种通信需求，包括电子邮件、Web浏览器、网络通信协议等。

4．5 故障处理

对可能的软件、硬件故障以及对各项性能而言所产生的后果进行处理。

5．性能需求

5．1 数据精确度

输出结果的精度。

5．2 时间特性

时间特性可包括如下几方面

·响应时间；

·更新处理时间；

·数据转换与传输时间；

·运行时间等。

5．3 适应性

在操作方式、运行环境、与其他软件的接口以及开发计划等发生变化时，软件的适应能力。

6．其他需求

列出在本文的其他部分未出现的需求。如果不需要增加其他需求，可省略这一部分。

7．数据描述

7．1 静态数据

7．2 动态数据

包括输入数据和输出数据。

7．3 数据库描述

给出使用数据库的名称和类型。

7．4 数据字典

对于数据流图、层次方框图中出现的所有图形元素在数据字典中都要作为一个词条加以定义，使得每一个图形元素都有唯一的一个清晰明确的解释。

数据字典中所有的定义必须是严密的、精确的，不可有二意性。

7．5 数据采集

·列出提供输入数据的机构、设备和人员

·列出数据输入的手段、介质和设备；

·列出数据生成的方法、介质和设备。

8．附录

包括分析模型，待定问题图表等。