原创力文档- 1、原创力文档（book118）网站文档一经付费（服务费），不意味着购买了该文档的版权，仅供个人/单位学习、研究之用，不得用于商业用途，未经授权，严禁复制、发行、汇编、翻译或者网络传播等，侵权必究。。
- 2、本站所有内容均由合作方或网友上传，本站不对文档的完整性、权威性及其观点立场正确性做任何保证或承诺！文档内容仅供研究参考，付费前请自行鉴别。如您付费，意味着您自己接受本站规则且自行承担风险，本站不退款、不进行额外附加服务；查看《如何避免下载的几个坑》。如果您已付费下载过本站文档，您可以点击 这里二次下载。
- 3、如文档侵犯商业秘密、侵犯著作权、侵犯人身权等，请点击“版权申诉”（推荐），也可以打举报电话：400-050-0827(电话支持时间：9:00-18:30)。
- 4、该文档为VIP文档，如果想要下载，成为VIP会员后，下载免费。
- 5、成为VIP后，下载本文档将扣除1次下载权益。下载后，不支持退款、换文档。如有疑问请联系我们。
- 6、成为VIP后，您将拥有八大权益，权益包括：VIP文档下载权益、阅读免打扰、文档格式转换、高级专利检索、专属身份标志、高级客服、多端互通、版权登记。
- 7、VIP文档为合作方或网友上传，每下载1次， 网站将根据用户上传文档的质量评分、类型等，对文档贡献者给予高额补贴、流量扶持。如果你也想贡献VIP文档。上传文档
查看更多
SOAR接口设计规范
SOAR接口设计规范
SOAR 接口设计规范v1.0
本文档适合于SOAR2009及以后版本。
一、名词描述：
a) 接口设计：指将本业务需要给其他业务提供的服务方法和进行远程调用的方法提取为接口的设计方式；
b) 接口：指上述设计所涉及的类，包括接口类及接口方法中所使用的业务对象（如VO ）和业务异常。不包括接口类的具体实现类；
c) 代码设计：指代码即为设计文档，要求其注释可生成JavaDoc 文件； d) 设计阶段：分为总体设计、详细设计；
二、设计要求：
a) 设计工具：采用Eclipse 直接进行代码设计；
b) 文档格式：JavaDoc 文档，文档中包含接口中使用的接口类、业务对象和业务异常的描述；
c) JavaDoc 注释要求：
符合标准JavaDoc 文档所要求的输写规范，具体写发详见JDK DOC帮助文件。对具体对象要求如下：
i. 接口类：
ii. 业务对象类：
iii. 业务异常类：
d) 不同设计阶段要求：
总体设计：明确描述接口类名称和用途，接口方法名称和用途；
详细设计：明确描述接口方法参数和返回值，明确描述方法使用的业务对象和异常，明确描述接口方法用例；
三、应用实例
a) 接口类：com.hzfc.soar.test.ITestBService
b) 业务对象类：com.hzfc.soar.test.BusinessVO
c) 业务异常类：com.hzfc.soar.test.BusinessException
d) 生成的JavaDoc 文件 i. ii.
文档评论（0）