接口说明书-模板
相关主题
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
接口类型设计要求1.取得一
致性
类似的情
况应该有
让使用者
有一致性
的操作。
在提示、
选单与说
明文件
中，应该
采用同样
的名词。
并且保持
命令的一
贯性。
2.提供有
意义的回
馈
接口在调
用过程
中，所返
回的返回
值的必须
是有意义
和易于处
理的。
3.容错性
所有接口
在设计过
程中，必
须考虑到
全部的可
能产生的
错误并对
这些错误
做出处理
并体现在
返回值中
。
所有接口
必须对传
入参数的
有效性进
行检查，
并体现于
返回值
中.
4.友好性
所有的接口中，必须对属性和方法做出
<summary >注释，便于调用者查阅5.安全性所有的接口模块，不允许开启异步的多线程，避免因为异步而产生的意外错误.