專利名稱:一種使用xml文件將文檔與程序代碼組織在一起的辦法的制作方法
技術(shù)領(lǐng)域:
本發(fā)明涉及一種使用XML文件將文檔與程序代碼組織在一起的辦法,特別 涉及一種采用在軟件開發(fā)過程中,使用規(guī)范格式的XML文件將軟件的文檔與程 序代碼組織在一起,并在后期可以自動生成Word文檔的方法。
背景技術(shù):
在軟件開發(fā)過程中,保持代碼與文檔的同步是一個比較棘手的問題。尤其 在客戶端-服務(wù)器模式的軟件開發(fā)中,如何讓客戶端方便地閱讀服務(wù)器所提供的 各個接口的文檔,也成為提高開發(fā)效率的比較重新的因素。本發(fā)明將提供一種 辦法,將代碼與文檔組織在一起,可以實現(xiàn)在寫代碼的同時實現(xiàn)對文檔的維護。
發(fā)明內(nèi)容
本發(fā)明所要解決的技術(shù)問題是提供一種采用在軟件開發(fā)過程中,使用規(guī)范 格式的XML文件將軟件的文檔與程序代碼組織在一起,并在后期可以自動生成 Word文檔的方法。
本發(fā)明所述的一種使用XML文件將文檔與程序代碼組織在一起的辦法,該 方法至少包括如下的步驟
步驟l:制定一種XML格式的文檔規(guī)范,使用規(guī)定的節(jié)點來存儲軟件的各種 信息。
步驟2:在解決方案目錄中,建立該格式的XML文檔。 步驟3:為客戶端提供一個各個服務(wù)接口的Web界面,客戶端可以方便地閱 讀各個接口的文檔。
步驟4:生成Word文檔。本發(fā)明所述的一種使用XML文件將文檔與程序代碼組織在一起的辦法,制定一種XML格式的文檔規(guī)范,使用規(guī)定的節(jié)點來存儲軟件的各種信息,其步驟
為
步驟ll: Summary作為功能的大致描述。步驟12: Remarks作為功能的詳細描述。步驟13: Information作為開發(fā)者等信息。步驟14: Histories作為開發(fā)維護的歷史。步驟15: Requirement作為需求分析。步驟16: Status Codes作為可能返回的狀態(tài)碼。
本發(fā)明所述的一種使用XML文件將文檔與程序代碼組織在一起的辦法,在解決方案目錄中,建立該格式的XML文檔,其步驟為
步驟21:在根目錄或子文件夾中,以功能模塊為單位建立這種格式的XML文檔。
步驟22:盡量填寫所有的信息,以保證文檔的完整。步驟23:如果日后維護,應在Histories中添加開發(fā)維護歷史。本發(fā)明所述的本發(fā)明所述的一種使用XML文件將文檔與程序代碼組織在一起的辦法,生成Word文檔,其步驟為
步驟41:使用程序?qū)⑺械腦ML文檔提取出來。步驟42:分析出其中的軟件信息,把各類信息匯總。步驟43:將匯總起來的信息生成Word文檔。
本發(fā)明涉及的一種使用XML文件將文檔與程序代碼組織在一起的辦法,使得在軟件開發(fā)過程中,使用規(guī)范格式的XML文件將軟件的文檔與程序代碼組織在一起,并在后期可以自動生成Word文檔。
圖1為本發(fā)明的流程圖。
具體實施例方式
參見圖1,本發(fā)明的主要步驟如下
步驟l:制定一種XML格式的文檔規(guī)范,使用規(guī)定的節(jié)點來存儲軟件的各種信息。
步驟2:在解決方案目錄中,建立該格式的XML文檔。步驟3:為客戶端提供一個各個服務(wù)接口的Web界面,客戶端可以方便地閱讀各個接口的文檔。
步驟4:生成Word文檔。
上述步驟1制定一種XML格式的文檔規(guī)范,使用規(guī)定的節(jié)點來存儲軟件的各種信息的具體步驟如下
步驟ll: Summary作為功能的大致描述。步驟12: Remarks作為功能的詳細描述。步驟13: Information作為開發(fā)者等信息。步驟14: Histories作為開發(fā)維護的歷史。步驟15: Requirement作為需求分析。步驟16: Status Codes作為可能返回的狀態(tài)碼。
上述步驟2在解決方案目錄中,建立該格式的XML文檔的具體步驟如下步驟21:.在根目錄或子文件夾中,以功能模塊為單位建立這種格式的XML文檔。
步驟22:盡量填寫所有的信息,以保證文檔的完整。
步驟22:如果日后維護,應在Histories中添加開發(fā)維護歷史。上述步驟4生成Word文檔的具體步驟如下步驟41:使用程序?qū)⑺械腦ML文檔提取出來。步驟42:分析出其中的軟件信息,把各類信息匯總。步驟43:將匯總起來的信息生成Word文檔。
上述的技術(shù)方案實施時使用XML文件將文檔與程序代碼組織在一起的辦法,使得在軟件開發(fā)過程中,使用規(guī)范格式的XML文件將軟件的文檔與程序代碼組織在一起,并在后期可以自動生成Word文檔。
最后所應說明的是,以上實施例僅用以說明而并非限制本發(fā)明所描述的技術(shù)方案;因此,盡管本說明書參照上述的實施例對本發(fā)明已進行了詳細的說明,但是,本領(lǐng)域的普通技術(shù)人員應當理解,仍然可以對本發(fā)明進行修改或者等同地替換;而一切不脫離本發(fā)明的精神和范圍的技術(shù)方案及其改進,其均應涵蓋在本發(fā)明的權(quán)利要求范圍當中。
權(quán)利要求
1、一種使用XML文件將文檔與程序代碼組織在一起的辦法,其特征在于該方法至少包括如下的步驟步驟1制定一種XML格式的文檔規(guī)范,使用規(guī)定的節(jié)點來存儲軟件的各種信息。步驟2在解決方案目錄中,建立該格式的XML文檔。步驟3為客戶端提供一個各個服務(wù)接口的Web界面,客戶端可以方便地閱讀各個接口的文檔。步驟4生成Word文檔。
2、 根據(jù)權(quán)利要求1所述的一種使用XML文件將文檔與程序代碼組織在一起 的辦法,其特征在于制定一種XML格式的文檔規(guī)范,使用規(guī)定的節(jié)點來存儲 軟件的各種信息,其步驟為步驟ll: Summary作為功能的大致描述。 步驟12: Remarks作為功能的詳細描述。 步驟13: Information作為開發(fā)者等信息。 步驟14: Histories作為開發(fā)維護的歷史。 步驟15: Requirement作為需求分析。 步驟16: Status Codes作為可能返回的狀態(tài)碼。
3、 根據(jù)權(quán)利要求1所述的一種使用XML文件將文檔與程序代碼組織在一起 的辦法,其特征在于在解決方案目錄中,建立該格式的XML文檔,其步驟為步驟21:在根目錄或子文件夾中,以功能模塊為單位建立這種格式的XML 文檔。步驟22:盡量填寫所有的信息,以保證文檔的完整。步驟23:如果日后維護,應在Histories中添加開發(fā)維護歷史。
4、根據(jù)權(quán)利要求1所述的一種使用XML文件將文檔與程序代碼組織在一起 的辦法,其特征在于生成Word文檔,其步驟為 步驟41:使用程序?qū)⑺械腦ML文檔提取出來。 步驟42:分析出其中的軟件信息,把各類信息匯總。 步驟43:將匯總起來的信息生成Word文檔。
全文摘要
一種使用XML文件將文檔與程序代碼組織在一起的辦法,首先制定一種XML格式的文檔規(guī)范,使用規(guī)定的節(jié)點來存儲軟件的各種信息;在解決方案目錄中,建立該格式的XML文檔;為客戶端提供一個各個服務(wù)接口的Web界面,客戶端可以方便地閱讀各個接口的文檔;最后生成Word文檔。本發(fā)明使得在軟件開發(fā)過程中,使用規(guī)范格式的XML文件將軟件的文檔與程序代碼組織在一起,并在后期可以自動生成Word文檔。
文檔編號G06F17/22GK101556577SQ200810103860
公開日2009年10月14日 申請日期2008年4月11日 優(yōu)先權(quán)日2008年4月11日
發(fā)明者瑩 劉, 濤 孫, 楠 張, 徐友春, 湯海京, 蔣海濤 申請人:北京聞言科技有限公司