本發(fā)明實施例涉及電子技術(shù)領(lǐng)域，特別涉及電子設備、技術(shù)文檔的生成方法及裝置。

背景技術(shù)：

工程師在開發(fā)過程中，基于代碼的可讀性，需要給代碼添加注釋，同時需要維護技術(shù)文檔以便于技術(shù)的介紹、說明和推行，因此技術(shù)研發(fā)需要維護“注釋文檔”和“技術(shù)文檔”兩種文件。當工程師維護的項目越來越多時，注釋和文檔的維護就顯得尤為重要，它們能幫助工程師更高效、清晰地完成開發(fā)任務。

在實現(xiàn)本發(fā)明過程中，發(fā)明人發(fā)現(xiàn)現(xiàn)有技術(shù)中至少存在如下問題：

1、效率低。由于需要同時維護兩種文件，修改更新代碼、注釋的同時，還需要手動去更新技術(shù)文檔，重復性工作較多，耗費時間。當項目任務繁瑣，常常更新一種文件忘了同步到另一種文件，造成文檔和注釋的差異，從而影響工程師開發(fā)。

2、維護成本高，同步性差。傳統(tǒng)的技術(shù)文檔，當更新工程代碼時，需要修改注釋，同時也需要手動更新技術(shù)文檔。

技術(shù)實現(xiàn)要素：

本發(fā)明實施例的目的在于提供一種電子設備、技術(shù)文檔的生成方法及裝置，可以減少開發(fā)人員維護技術(shù)文檔的工作量，提高效率，并且保證了注釋和文檔的同步性，降低維護成本。

第一方面，本發(fā)明的實施例提供了一種技術(shù)文檔的生成方法，應用于包括至少一代碼段的代碼文件，所述技術(shù)文檔的生成方法包括：讀取所述代碼文件，并提取所述代碼段對應的符合預設規(guī)則的代碼注釋；根據(jù)所述預設規(guī)則對所述代碼注釋進行解析，并提取所述代碼段對應的多個注釋項；根據(jù)所述代碼段對應的多個注釋項生成所述代碼文件對應的技術(shù)文檔。

第二方面，本發(fā)明的實施例提供了一種技術(shù)文檔的生成裝置，包括：應用于包括至少一代碼段的代碼文件，所述技術(shù)文檔的生成裝置包括：代碼注釋提取模塊，用于讀取所述代碼文件，并提取所述代碼段對應的符合預設規(guī)則的代碼注釋；代碼注釋解析模塊，用于根據(jù)所述預設規(guī)則對所述代碼注釋進行解析，并提取所述代碼段對應的多個注釋項；文檔生成模塊，用于根據(jù)所述多個注釋項生成所述代碼文件對應的技術(shù)文檔。

第三方面，本發(fā)明的實施例提供了一種電子設備，包括：至少一個處理器；以及，與所述至少一個處理器通信連接的存儲器；其中，所述存儲器存儲有可被所述一個處理器執(zhí)行的指令，所述指令被被所述至少一個處理器執(zhí)行，以使所述至少一個處理器能夠：讀取所述代碼文件，并提取所述代碼段對應的符合預設規(guī)則的代碼注釋；根據(jù)所述預設規(guī)則對所述代碼注釋進行解析，并提取所述代碼段對應的多個注釋項；根據(jù)所述代碼段對應的多個注釋項生成所述代碼文件對應的技術(shù)文檔。

第四方面，本發(fā)明實施例提供了一種計算機程序產(chǎn)品，包括存儲在非暫態(tài)計算機可讀存儲介質(zhì)上的計算機程序，計算機程序包括程序指令，當程序指令被計算機執(zhí)行時，使計算機執(zhí)行本發(fā)明實施例的上述技術(shù)文檔的生成方法。

第五方面，本發(fā)明實施例提供了一種非易失性計算機存儲介質(zhì)，存儲有計算機可執(zhí)行指令，計算機可執(zhí)行指令用于執(zhí)行本發(fā)明實施例上述技術(shù)文檔的生成方法。

本發(fā)明實施例相對于現(xiàn)有技術(shù)而言，可以根據(jù)代碼段對應的注釋項自動生成技術(shù)文檔，開發(fā)者只需要根據(jù)一套通用的格式來維護代碼注釋，當更新工程代碼時，只需要修改注釋，技術(shù)文檔會根據(jù)代碼注釋自動生成，而不需要手動去更新技術(shù)文檔。這樣減少開發(fā)人員的工作量，提高了效率，并且保證了注釋和文檔的同步性，降低了維護成本。

另外，在所述根據(jù)所述預設規(guī)則對所述代碼注釋進行解析，并提取所述代碼段對應的多個注釋項中，具體包括：檢測所述代碼注釋中的多個預設關(guān)鍵字，并將多個所述預設關(guān)鍵字綁定的數(shù)據(jù)分別提取出來作為多個所述注釋項。本實施例提供了根據(jù)預設規(guī)則對代碼注釋進行解析，并提取代碼段對應的多個注釋項的一種具體實現(xiàn)方式。

另外，在根據(jù)所述代碼段對應的多個注釋項生成所述代碼文件對應的技術(shù)文檔中，具體包括：獲取預存的模板文件；所述模板文件中包括每個所述預設關(guān)鍵字對應的填充區(qū)；將每個所述注釋項填寫至每個所述注釋項綁定的預設關(guān)鍵字對應的填充區(qū)中。本實施例提供了根據(jù)代碼段對應的多個注釋項生成代碼文件對應的技術(shù)文檔的一種具體實現(xiàn)方式。

另外，所述代碼段的數(shù)目為多個，且每個所述代碼段對應的多個注釋項中包括一個代碼段名稱；在根據(jù)所述代碼段對應的多個注釋項生成所述代碼文件對應的技術(shù)文檔之后，還包括：根據(jù)每個所述代碼段的代碼段名稱建立所述技術(shù)文檔的代碼段索引目錄。通過建立代碼段索引目錄便于開發(fā)人員在技術(shù)文檔中查找每個代碼段對應的多個注釋項。

另外，每個所述代碼段對應的多個注釋項中還包括代碼段類型；在所述根據(jù)每個所述代碼段的代碼段名稱建立所述技術(shù)文檔的代碼段索引目錄之后，還包括：根據(jù)每個所述代碼段的代碼段類型，將所述代碼段索引目錄劃分為分別對應于多種代碼段類型的多個索引區(qū)。這樣，可以將同一類型的代碼段劃在一個索引區(qū)內(nèi)，在代碼段的數(shù)目為多時，便于對多個代碼段管理，也方便查找代碼段。

附圖說明

一個或多個實施例通過與之對應的附圖中的圖片進行示例性說明，這些示例性說明并不構(gòu)成對實施例的限定，附圖中具有相同參考數(shù)字標號的元件表示為類似的元件，除非有特別申明，附圖中的圖不構(gòu)成比例限制。

圖1是根據(jù)本發(fā)明第一實施例的技術(shù)文檔的生成方法流程圖；

圖2是根據(jù)本發(fā)明第二實施例的技術(shù)文檔的生成方法流程圖；

圖3是根據(jù)本發(fā)明第二實施例中的代碼注釋圖；

圖4是根據(jù)本發(fā)明第二實施例中的技術(shù)文檔示意圖；

圖5是根據(jù)本發(fā)明第三實施例的技術(shù)文檔的生成方法流程圖；

圖6是根據(jù)本發(fā)明第三實施例中的技術(shù)文檔示意圖；

圖7是根據(jù)本發(fā)明第四實施例的技術(shù)文檔的生成裝置的結(jié)構(gòu)示意圖；

圖8是根據(jù)本發(fā)明第五實施例的技術(shù)文檔的生成裝置的結(jié)構(gòu)示意圖；

圖9是根據(jù)本發(fā)明第六實施例的技術(shù)文檔的生成裝置的結(jié)構(gòu)示意圖；

圖10是根據(jù)本發(fā)明第七實施例的電子設備的結(jié)構(gòu)示意圖。

具體實施例

為使本發(fā)明實施例的目的、技術(shù)方案和優(yōu)點更加清楚，下面將結(jié)合附圖對本發(fā)明的各實施例進行詳細的闡述。然而，本領(lǐng)域的普通技術(shù)人員可以理解，在本發(fā)明各實施例中，為了使讀者更好地理解本申請而提出了許多技術(shù)細節(jié)。但是，即使沒有這些技術(shù)細節(jié)和基于以下各實施例的種種變化和修改，也可以實現(xiàn)本申請所要求保護的技術(shù)方案。

本發(fā)明的第一實施例涉及一種技術(shù)文檔的生成方法，其流程如圖1所示，具體如下：

在步驟101中，讀取代碼文件。其中，本實施例中的代碼文件中包括至少一代碼段。一般而言，一個代碼文件中會包括多個代碼段，每個代碼段用于實現(xiàn)一種功能。

在步驟102中，提取代碼段對應的代碼注釋，其中代碼注釋符合預設規(guī)則。具體地說，該預設規(guī)則可以為工程師寫入代碼注釋時設定的規(guī)則，比如說：代碼注釋的每一段為一個注釋項，并且，第一個注釋項(即第一段)表示代碼段名稱，第二個注釋項(即第二段)表示代碼段撰寫日期，第三個注釋項(即第三段)表示代碼段版本等等。

在步驟103中，根據(jù)預設規(guī)則對代碼注釋進行解析并提取代碼段對應的多個注釋項。具體的說，提取的多個注釋項中可以包括代碼段名稱、代碼段描述、代碼段類參數(shù)、代碼作者以及代碼鏈接地址等等。

在步驟104中，根據(jù)代碼段對應的多個注釋項生成代碼文件對應的技術(shù)文檔。具體地說，可以按照預設的規(guī)則自動生成代碼文件對應的技術(shù)文檔，其中，該技術(shù)文檔中包含從代碼注釋中解析出來的該代碼段對應的每個注釋項。

本實施例相對于現(xiàn)有技術(shù)而言，可以根據(jù)代碼段對應的注釋項自動生成技術(shù)文檔，開發(fā)者只需要根據(jù)一套通用的格式來維護代碼注釋，當更新工程代碼時，只需要修改注釋，技術(shù)文檔會根據(jù)代碼注釋自動生成，而不需要手動去更新技術(shù)文檔。這樣減少開發(fā)人員的工作量，提高了效率，并且保證了注釋和文檔的同步性，降低了維護成本。

本發(fā)明的第二實施例涉及一種技術(shù)文檔的生成方法。第二實施例對第一實施例進行了細化，細化之處在于：提供了提取代碼段對應的多個注釋項以及生成代碼文件對應的技術(shù)文檔的具體實現(xiàn)方式。本實施例中技術(shù)文檔的生成方法流程如圖2所示，具體如下：

在步驟201中，讀取代碼文件。其中，本實施例中的代碼文件中包括至少一代碼段。一般而言，一個代碼文件中會包括多個代碼段，每個代碼段用于實現(xiàn)一種功能。

在步驟202中，提取代碼段對應的符合預設規(guī)則的代碼注釋。具體地說，該預設規(guī)則可以為工程師寫入代碼注釋時設定的規(guī)則。比如說：代碼注釋的每一段為一個注釋項，并且，第一個注釋項(即第一段)表示代碼段名稱，第二個注釋項(即第二段)表示代碼段撰寫日期，第三個注釋項(即第三段)表示代碼段版本等等，如圖3所示。

在步驟203中，根據(jù)預設規(guī)則對代碼注釋進行解析并提取代碼段對應的多個注釋項。具體的說，提取的每個代碼段對應的多個注釋項中包括一個代碼段名稱、一個代碼段描述以及至少一個代碼段類參數(shù)，實際應用中還可以包括代碼作者以及代碼鏈接地址等等。比如說，如圖3中所示的代碼段中，代碼段名稱為“對話框”，代碼段描述為“dialog”，代碼段類參數(shù)為“{obiect}opts參數(shù)”“{number}opts.width對話框?qū)挾?，默認300px”“{number}opts.height對話框高度，默認自動”等等。其中，每個代碼段類參數(shù)包括參數(shù)類型、參數(shù)名稱以及參數(shù)解釋，比如在代碼段類參數(shù)“{obiect}opts參數(shù)”中，參數(shù)類型為“obiect”、參數(shù)名稱為“opts”、參數(shù)解釋為“參數(shù)”。本步驟中包含子步驟2031和子步驟2032。

在子步驟2031中，檢測代碼注釋中的多個預設關(guān)鍵字。具體地說，代碼注釋中的多個預設關(guān)鍵字可以為每一個注釋項中的預設關(guān)鍵字，比如說：代碼段描述“dialog”對應的預設關(guān)鍵字為“constructs”；代碼段類參數(shù)“{obiect}opts參數(shù)”“{number}opts.width對話框?qū)挾?，默認300px”“{number}opts.height對話框高度，默認自動”對應的預設關(guān)鍵字為“param”等等。

在子步驟2032中，將多個預設關(guān)鍵字綁定的數(shù)據(jù)分別提取出來作為多個注釋項。比如說，預設關(guān)鍵字“constructs”綁定的數(shù)據(jù)內(nèi)容為“dialog”，本實施例中，每個預設關(guān)鍵字可以以前綴形式或者后綴形式綁定于每個預設關(guān)鍵字對應的注釋項，比如圖3中注釋項“@date2015.04.30”中的預設關(guān)鍵字“date”是以前綴的形式綁定對應的注釋項。

在步驟204中，根據(jù)代碼段對應的多個注釋項生成代碼文件對應的技術(shù)文檔。具體地說本步驟包含本步驟中包含子步驟2041和子步驟2042。

在子步驟2041中，獲取預存的模板文件。具體地說，模板文件中包括每個預設關(guān)鍵字對應的填充區(qū)。具體地說，可以在后臺建立注釋項中各個預設關(guān)鍵字與填充區(qū)的對應關(guān)系，比如說模板文件中的“描述”對應注釋項的預設關(guān)鍵字“constructs”，模板文件中的“作者”對應注釋項中的預設關(guān)鍵字“author”等等。

在子步驟2042中，將每個注釋項填寫至每個注釋項綁定的預設關(guān)鍵字對應的填充區(qū)中。具體地說，將每個預設關(guān)鍵字對應的注釋項的內(nèi)容填充到相應的填充區(qū)，比如說，以預設關(guān)鍵字“constructs”為例，其對應的注釋項的內(nèi)容為“dialog”，將“dialog”填充到模板文件中“描述”對應的填充區(qū)中。

優(yōu)選的，本實施方式中也可以將預設關(guān)鍵字以中文的形式顯示顯示，比如說，預設關(guān)鍵字“constructs”在模板文件顯示為“描述”，預設關(guān)鍵字“constructs”綁定的內(nèi)容在模板文件顯示為“對話框”，如圖4中所示。

本實施例相對于第一實施例而言，提供了根據(jù)預設規(guī)則對代碼注釋進行解析，并提取代碼段對應的多個注釋項以及根據(jù)代碼段對應的多個注釋項生成代碼文件對應的技術(shù)文檔的一種具體實現(xiàn)方式，且計算簡單，易于實現(xiàn)。

本發(fā)明的第三實施例涉及一種技術(shù)文檔的生成方法。第三實施例在第一實施例的基礎(chǔ)上作了改進，改進之處在于：在生成代碼文件對應的技術(shù)文檔之后還可以建立代碼段索引目錄并劃分索引區(qū)，本實施例中技術(shù)文檔的生成方法的流程如圖5所示，具體如下：

在步驟501中，讀取代碼文件。具體地說，本實施例中的代碼文件中包括多個代碼段，每個代碼段用于實現(xiàn)一種功能。且每個代碼段對應的多個注釋項中包括一個代碼段名稱以及代碼段類型，需要說明的是，在實際應用中，每個代碼段對應的多個注釋項中還可以包括一個代碼段描述、至少一個代碼段類參數(shù)、代碼作者以及代碼鏈接地址等等。其中，每個代碼段類參數(shù)包括參數(shù)類型、參數(shù)名稱以及參數(shù)解釋。

在步驟502中，提取代碼段對應的符合預設規(guī)則的代碼注釋。具體地說，提取每個代碼段對應的符合預設規(guī)則的代碼注釋，該預設規(guī)則可以為工程師寫入代碼注釋時設定的規(guī)則，比如說：代碼注釋的每一段為一個注釋項，并且，第一個注釋項(即第一段)表示代碼段名稱，第二個注釋項(即第二段)表示代碼段撰寫日期，第三個注釋項(即第三段)表示代碼段版本等等。

在步驟503中，根據(jù)預設規(guī)則對代碼注釋進行解析并提取代碼段對應的多個注釋項。具體地說，提取的每個代碼段對應的多個注釋項中包括一個代碼段名稱、一個代碼段描述以及至少一個代碼段類參數(shù)，還可以包括代碼作者以及代碼鏈接地址等等。

在步驟504中，根據(jù)代碼段對應的多個注釋項生成代碼文件對應的技術(shù)文檔。具體地說，可以按照預設的規(guī)則自動生成代碼文件對應的技術(shù)文檔，其中，該技術(shù)文檔中包含代碼段中的每個注釋項以及每個注釋項中對應的多個參數(shù)。

在步驟505中，根據(jù)每個代碼段的代碼段名稱建立技術(shù)文檔的代碼段索引目錄。具體地說，本實施方式中的每個代碼段都包括一個代碼段名稱，將每個代碼段的名稱提取出來建成一個目錄。如圖6所示，圖中“audio”“calendar”“cutpicture”“drag”等即為代碼段名稱，這些代碼段名稱組成的目錄即為代碼段索引目錄，當點開目錄中的其中一個代碼段名稱時，即可以查看該代碼段名稱對應的代碼段的相關(guān)注釋。

在步驟506中，根據(jù)每個代碼段的代碼段類型，將代碼段索引目錄劃分為分別對應于多種代碼段類型的多個索引區(qū)。具體地說，可以根據(jù)每個代碼段名稱對應的注釋項中的關(guān)于代碼段類型的定義來判斷代碼段的類型，并將屬于同一種類型的代碼段劃分為一個索引區(qū)。比如說：“audio”“calendar”“cutpicture”“drag”等這些代碼段名稱所代表的代碼段類型相同，都屬于“組件”類，則可以將這些代碼段的索引目錄劃分在一個索引區(qū)內(nèi)，索引區(qū)的名稱為“組件”；“core.bassclass”“util.addtimetourl”“sle.g3”等這些代碼段名稱所代表的代碼段類型相同，都屬于“通用”類，則可以將這些代碼段的索引目錄劃分在一個索引區(qū)內(nèi)，索引區(qū)的名稱為“通用(ro)”。如圖6中所示，圖6中示出了2個索引區(qū)“組件”“ro”的情況。

本實施例相對于第一實施例而言，通過建立代碼段索引目錄便于開發(fā)人員在技術(shù)文檔中查找每個代碼段對應的多個注釋項。將同一類型的代碼段劃在一個索引區(qū)內(nèi)，這樣在代碼段的數(shù)目為多時，便于對多個代碼段管理，也方便查找代碼段。

上面各種方法的步驟劃分，只是為了描述清楚，實現(xiàn)時可以合并為一個步驟或者對某些步驟進行拆分，分解為多個步驟，只要包括相同的邏輯關(guān)系，都在本專利的保護范圍內(nèi)；對算法中或者流程中添加無關(guān)緊要的修改或者引入無關(guān)緊要的設計，但不改變其算法和流程的核心設計都在該專利的保護范圍內(nèi)。

本發(fā)明第四實施例涉及一種技術(shù)文檔的生成裝置，應用于包括至少一代碼段的代碼文件，所本實施例中技術(shù)文檔的生成裝置包括：代碼注釋提取模塊1、代碼注釋解析模塊2和文檔生成模塊3，如圖7所示。

代碼注釋提取模塊1用于讀取代碼文件，并提取代碼段對應的代碼注釋，其中，代碼注釋符合預設規(guī)則。

代碼注釋解析模塊2用于根據(jù)預設規(guī)則對代碼注釋進行解析，并提取代碼段對應的多個注釋項。

文檔生成模塊3用于根據(jù)多個注釋項生成代碼文件對應的技術(shù)文檔。

本實施例相對于現(xiàn)有技術(shù)而言，可以根據(jù)代碼段對應的注釋項自動生成技術(shù)文檔，開發(fā)者只需要根據(jù)一套通用的格式來維護代碼注釋，當更新工程代碼時，只需要修改注釋，文檔生成模塊會根據(jù)代碼注釋自動生成新的技術(shù)文檔，而不需要手動去更新技術(shù)文檔。這樣減少開發(fā)人員的工作量，提高了效率，并且保證了注釋和文檔的同步性，降低了維護成本。

不難發(fā)現(xiàn)，本實施例為與第一實施例相對應的裝置實施例，本實施例可與第一實施例互相配合實施。第一實施例中提到的相關(guān)技術(shù)細節(jié)在本實施例中依然有效，為了減少重復，這里不再贅述。相應地，本實施例中提到的相關(guān)技術(shù)細節(jié)也可應用在第一實施例中。

值得一提的是，本實施例中所涉及到的各模塊均為邏輯模塊，在實際應用中，一個邏輯單元可以是一個物理單元，也可以是一個物理單元的一部分，還可以以多個物理單元的組合實現(xiàn)。此外，為了突出本發(fā)明的創(chuàng)新部分，本實施例中并沒有將與解決本發(fā)明所提出的技術(shù)問題關(guān)系不太密切的單元引入，但這并不表明本實施例中不存在其它的單元。

本發(fā)明第五實施例涉及一種技術(shù)文檔的生成裝置。第五實施例在第四實施例的基礎(chǔ)上作了改進，改進之處在于：在本實施例中，文檔生成模塊3包括模板獲取單元31和填充單元32，如圖8所示。

具體地說，本實施例中的代碼注釋解析模塊2還用于檢測代碼注釋中的多個預設關(guān)鍵字，并將多個預設關(guān)鍵字綁定的數(shù)據(jù)分別提取出來作為多個注釋項。

模板獲取單元31用于獲取預存的模板文件。其中，模板文件中包括每個預設關(guān)鍵字對應的填充區(qū)。

填充單元32用于將每個注釋項填寫至注釋項綁定的預設關(guān)鍵字對應的填充區(qū)中。

本實施例相對于第五實施例而言，通過模板獲取單元31和填充單元32實現(xiàn)根據(jù)代碼段對應的多個注釋項自動生成代碼文件對應的技術(shù)文檔，且計算簡單，易于實現(xiàn)。

由于第二實施例與本實施例相互對應，因此本實施例可與第二實施例互相配合實施。第二實施例中提到的相關(guān)技術(shù)細節(jié)在本實施例中依然有效，在第二實施例中所能達到的技術(shù)效果在本實施例中也同樣可以實現(xiàn)，為了減少重復，這里不再贅述。相應地，本實施例中提到的相關(guān)技術(shù)細節(jié)也可應用在第二實施例中。

本發(fā)明第六實施例涉及一種技術(shù)文檔的生成裝置。第六實施例在第四實施例的基礎(chǔ)上作了改進，改進之處在于：在本實施例中的技術(shù)文檔的生成裝置還包括索引目錄建立模塊4和索引區(qū)劃分模塊5，如圖9所示。

具體地說，本實施例中的代碼段的數(shù)目可以為多個，且每個代碼段對應的多個注釋項中包括一個代碼段名稱以及代碼段類型。

索引目錄建立模塊4用于根據(jù)每個代碼段的代碼段名稱建立技術(shù)文檔的代碼段索引目錄。

索引區(qū)劃分模塊5用于根據(jù)每個代碼段的代碼段類型，將代碼段索引目錄劃分為分別對應于多種代碼段類型的多個索引區(qū)。

本實施例相對于第四實施例而言，通過索引目錄建立代碼段索引目錄便于開發(fā)人員在技術(shù)文檔中查找每個代碼段對應的多個注釋項。通過索引區(qū)劃分模塊將同一類型的代碼段劃在一個索引區(qū)內(nèi)，這樣在代碼段的數(shù)目為多時，便于對多個代碼段管理，也方便查找代碼段。

不難發(fā)現(xiàn)，本實施例為與第三實施例相對應的裝置實施例，本實施例可與第三實施例互相配合實施。第三實施例中提到的相關(guān)技術(shù)細節(jié)在本實施例中依然有效，為了減少重復，這里不再贅述。相應地，本實施例中提到的相關(guān)技術(shù)細節(jié)也可應用在第三實施例中。

本發(fā)明第七實施例涉及一種電子設備，如圖10所示，該電子設備包括：至少一個處理器6以及與至少一個處理器6通信連接的存儲器7，圖10中以一個處理器6為例。

該電子設備還可以包括：輸入裝置8和輸出裝置9。

處理器6、存儲器7、輸入裝置8和輸出裝置9可以通過總線或者其他方式連接，圖10中以通過總線連接為例。

存儲器7作為一種非暫態(tài)計算機可讀存儲介質(zhì)，可用于存儲非暫態(tài)軟件程序、非暫態(tài)計算機可執(zhí)行程序以及模塊，如本發(fā)明實施例中的技術(shù)文檔的生成方法對應的程序指令/模塊(例如，附圖7中所示的代碼注釋提取模塊1、代碼注釋解析模塊2和文檔生成模塊3)。處理器6通過運行存儲在存儲器7中的非暫態(tài)軟件程序、指令以及模塊，從而執(zhí)行服務器的各種功能應用以及數(shù)據(jù)處理，即實現(xiàn)上述方法實施例中的技術(shù)文檔的生成方法。

存儲器7可以包括存儲程序區(qū)和存儲數(shù)據(jù)區(qū)，其中，存儲程序區(qū)可存儲操作系統(tǒng)、至少一個功能所需要的應用程序；存儲數(shù)據(jù)區(qū)可存儲根據(jù)列表項操作的處理裝置的使用所創(chuàng)建的數(shù)據(jù)等。此外，存儲器7可以包括高速隨機存取存儲器，還可以包括非暫態(tài)存儲器，例如至少一個磁盤存儲器件、閃存器件、或其他非暫態(tài)固態(tài)存儲器件。在一些實施例中，存儲器7可選包括相對于處理器6遠程設置的存儲器，這些遠程存儲器可以通過網(wǎng)絡連接至用于技術(shù)文檔的生成方法的處理器7。上述網(wǎng)絡的實例包括但不限于互聯(lián)網(wǎng)、企業(yè)內(nèi)部網(wǎng)、局域網(wǎng)、移動通信網(wǎng)及其組合。

輸入裝置8可接收輸入的數(shù)字或字符信息，以及產(chǎn)生與列表項操作的處理裝置的用戶設置以及功能控制有關(guān)的鍵信號輸入。輸出裝置9可包括顯示屏等顯示設備。

本實施例中，當存儲器7中存儲的一個或多個模塊(例如，附圖7中所示的代碼注釋提取模塊1、代碼注釋解析模塊2和文檔生成模塊3)被所述一個或者多個處理器6執(zhí)行時，處理器6執(zhí)行上述任意方法實施例中的技術(shù)文檔的生成方法，即執(zhí)行：讀取代碼文件，并提取代碼段對應的符合預設規(guī)則的代碼注釋；根據(jù)預設規(guī)則對代碼注釋進行解析，并提取代碼段對應的多個注釋項；根據(jù)代碼段對應的多個注釋項生成代碼文件對應的技術(shù)文檔。

上述產(chǎn)品可執(zhí)行本申請實施例所提供的方法，具備執(zhí)行方法相應的功能模塊和有益效果。未在本實施例中詳盡描述的技術(shù)細節(jié)，可參見本申請實施例所提供的方法。

本發(fā)明實施例的電子設備以多種形式存在，包括但不限于：

(1)移動通信設備:這類設備的特點是具備移動通信功能，并且以提供話音、數(shù)據(jù)通信為主要目標。這類終端包括:智能手機(例如iphone)、多媒體手機、功能性手機，以及低端手機等。

(2)超移動個人計算機設備:這類設備屬于個人計算機的范疇，有計算和處理功能，一般也具備移動上網(wǎng)特性。這類終端包括:pda、mid和umpc設備等，例如ipad。

(3)便攜式娛樂設備:這類設備可以顯示和播放多媒體內(nèi)容。該類設備包括:音頻、視頻播放器(例如ipod)，掌上游戲機，電子書，以及智能玩具和便攜式車載導航設備。

本實施例相對于現(xiàn)有技術(shù)而言，可以根據(jù)代碼段對應的注釋項自動生成技術(shù)文檔，開發(fā)者只需要根據(jù)一套通用的格式來維護代碼注釋，當更新工程代碼時，只需要修改注釋，技術(shù)文檔會根據(jù)代碼注釋自動生成，而不需要手動去更新技術(shù)文檔。這樣減少開發(fā)人員的工作量，提高了效率，并且保證了注釋和文檔的同步性，降低了維護成本。

本發(fā)明第八實施例涉及一種非易失性計算機存儲介質(zhì)，該計算機存儲介質(zhì)存儲有計算機可執(zhí)行指令，該計算機可執(zhí)行指令可執(zhí)行上述任意方法實施例中的技術(shù)文檔的生成方法。

本實施例相對于現(xiàn)有技術(shù)而言，可以根據(jù)代碼段對應的注釋項自動生成技術(shù)文檔，開發(fā)者只需要根據(jù)一套通用的格式來維護代碼注釋，當更新工程代碼時，只需要修改注釋，技術(shù)文檔會根據(jù)代碼注釋自動生成，而不需要手動去更新技術(shù)文檔。這樣減少開發(fā)人員的工作量，提高了效率，并且保證了注釋和文檔的同步性，降低了維護成本。

本發(fā)明第九實施例涉及一種計算機程序產(chǎn)品，能夠執(zhí)行上述任意方法實施例中的技術(shù)文檔的生成方法。

本實施例相對于現(xiàn)有技術(shù)而言，可以根據(jù)代碼段對應的注釋項自動生成技術(shù)文檔，開發(fā)者只需要根據(jù)一套通用的格式來維護代碼注釋，當更新工程代碼時，只需要修改注釋，技術(shù)文檔會根據(jù)代碼注釋自動生成，而不需要手動去更新技術(shù)文檔。這樣減少開發(fā)人員的工作量，提高了效率，并且保證了注釋和文檔的同步性，降低了維護成本。

本領(lǐng)域技術(shù)人員可以理解實現(xiàn)上述實施例方法中的全部或部分步驟是可以通過程序來指令相關(guān)的硬件來完成，該程序存儲在一個存儲介質(zhì)中，包括若干指令用以使得一個設備(可以是單片機，芯片等)或處理器(processor)執(zhí)行本申請各個實施例所述方法的全部或部分步驟。而前述的存儲介質(zhì)包括：u盤、移動硬盤、只讀存儲器(rom，read-onlymemory)、隨機存取存儲器(ram，randomaccessmemory)、磁碟或者光盤等各種可以存儲程序代碼的介質(zhì)。

本領(lǐng)域的普通技術(shù)人員可以理解，上述各實施例是實現(xiàn)本發(fā)明的具體實施例，而在實際應用中，可以在形式上和細節(jié)上對其作各種改變，而不偏離本發(fā)明的精神和范圍。