android开发接口文档怎么写( 二 ) _接口

说明准备在本程序中安排的注释，如：
a. 加在模块首部的注释；
b.加在各分枝点处的注释；对各变量的功能、范围、缺省条件等所加的注释；
d.对使用的逻辑所加的注释等等。
3.11限制条件
说明本程序运行中所受到的限制条件。
3.12测试计划
说明对本程序进行单体测试的计划，包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。
3.13尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
4 程序2（标识符）设计说明
用类似3的方式，说明第2个程序乃至第N个程序的设计考虑。
4.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浏览器、网络通信协议等。