NC接口設計規(guī)范

NC接口設計規(guī)范v1.0本文檔適合于NC5.0及以后版本。名詞描述：接口設計：指將本業(yè)務需要給其他業(yè)務提供的服務方法和進行遠程調(diào)用的方法提取為接口的設計方式；接口：指上述設計所涉及的類，包括接口類及接口方法中所使用的業(yè)務對象（如VO）和業(yè)務異常。不包括接口類的具體實現(xiàn)類；代碼設計：指代碼即為設計文檔，要求其注釋可生成JavaDoc文件；設計階段：分為總體設計、詳細設計；設計要求：設計工具：采用Eclipse直接進行代碼設計；文檔格式：JavaDoc文檔，文檔中包含接口中使用的接口類、業(yè)務對象和業(yè)務異常的描述；JavaDoc注釋要求：符合標準JavaDoc文檔所要求的輸寫規(guī)范，具體寫發(fā)詳見JDKDOC幫助文件。對具體對象要求如下：接口類：類注釋：類注釋應該在import語句的后面在類聲明的前面；/***（接口類簡要描繪，必須以句號為結(jié)束）.*<p>*<strong>提供者：</strong>（提供業(yè)務組）*<p>*<strong>使用者：</strong>（使用業(yè)務組，若分方法描述可省略此項）*<p>*<strong>設計狀態(tài)：</strong>（指出接口類設計階段：總體、詳細）*<p>*@version（接口版本）*@author（接口類總設計負責人）*/方法注釋：方法注釋要緊靠方法的前面；/** *（接口方法簡要描述，必須以句號為結(jié)束）. *<p> *<strong>調(diào)用模塊：</strong> *（明確指出本接口適用范圍：公共、私有或具體應用業(yè)務模塊）*<p> *<strong>最后修改人：</strong> *<p> *<strong>最后修改日前：</strong> *<p> *<strong>用例描述：</strong> *<p> *@param （參數(shù)用途描述） *@return （返回值描述） *@throws （異常描述） *@since （開始使用的NC版本） *@see （關聯(lián)類） */業(yè)務對象類：類注釋/***（業(yè)務對象類簡要描繪，必須以句號為結(jié)束）.*<p>*<strong>擁有者：</strong>（擁有業(yè)務對象的業(yè)務組）*<p>*<strong>設計狀態(tài)：</strong>（指出接口類設計階段：總體、詳細）*<p>*@version（業(yè)務對象版本）*@author（作者/最后修改人）*@since（開始使用的NC版本）*/get方法注釋 /** *（屬性簡要描述，必須以句號為結(jié)束）. *@return */set方法注釋 /** *（屬性簡要描述，必須以句號為結(jié)束）. *@param（參數(shù)用途描述） */業(yè)務異常類：類注釋/***（業(yè)務異常類簡要描繪，必須以句號為結(jié)束）.*<p>*<strong>擁有者：</strong>（擁有異常的業(yè)務組）*<p>*<strong>設計狀態(tài)：</strong>（指出接口類設計階段：總體、詳細）*<p>*@version（業(yè)務異常類版本）*@author（作者/最后修改人）*@since （開始使用的NC版本）*@see （關聯(lián)類）*/構(gòu)造方法注釋 /** *（異常構(gòu)造的簡要描述，必須以句號為結(jié)束）. */不同設計階段要求：總體設計：明確描述接口類名稱和用途，接口方法名稱和用途；詳細設計：明確描述接口方法參數(shù)和返回值，明確描述方法使用的業(yè)務對象和異常，明確描述接口方法用例；應用實例接口類：nc.itf.uap.test.ITestBService業(yè)