本發(fā)明實(shí)施例涉及持續(xù)集成技術(shù)領(lǐng)域，特別是涉及一種持續(xù)集成中的代碼文檔生成方法、裝置及系統(tǒng)。

背景技術(shù)：

持續(xù)集成在系統(tǒng)開發(fā)的過程中起著非常重要的作用，并且代碼文檔的輸出屬于持續(xù)集成過程中的最后一步，也就是將代碼文檔進(jìn)行發(fā)布。代碼文檔包括每個(gè)方法或接口的作用，輸入及輸出參數(shù)的說明等等。在系統(tǒng)開發(fā)的過程中，代碼文檔是非常重要的，完善、詳盡的代碼文檔不僅可以方便上下游模塊的開發(fā)人員進(jìn)行交流，也可以為測(cè)試人員提供詳盡的測(cè)試說明，減少不必要的討論，從而提升工作效率。

在將代碼文檔進(jìn)行發(fā)布之前需要生成相應(yīng)的代碼文檔，現(xiàn)有技術(shù)中是通過工作人員手動(dòng)編輯相關(guān)信息從而形成代碼文檔的，并且當(dāng)對(duì)代碼進(jìn)行相應(yīng)的更改后還需要手動(dòng)對(duì)代碼文檔進(jìn)行更新，從而導(dǎo)致代碼文檔的更新不及時(shí)，并在一定程度上造成人力資源浪費(fèi)、降低工作效率及代碼文檔的準(zhǔn)確性。

因此，如何提供一種解決上述問題的持續(xù)集成中的代碼文檔生成方法、裝置及系統(tǒng)成為本領(lǐng)域的技術(shù)人員目前需要解決的問題。

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

本發(fā)明實(shí)施例的目的是提供一種持續(xù)集成中的代碼文檔生成方法、裝置及系統(tǒng)，在使用過程中實(shí)現(xiàn)了代碼文檔的自動(dòng)生成與及時(shí)更新，并且在一定程度上節(jié)約了人力資源、提高了工作效率及代碼文檔的準(zhǔn)確性。

為解決上述技術(shù)問題，本發(fā)明實(shí)施例提供了一種持續(xù)集成中的代碼文檔生成方法，包括：

s11：獲取用戶提交的代碼及代碼注釋；

s12：依據(jù)所述代碼判斷所述代碼注釋是否正確，如果是，則將所述代碼及所述代碼注釋存儲(chǔ)至代碼庫(kù)，并進(jìn)入s13；否則，返回提示信息；

s13：獲取所述代碼的代碼結(jié)構(gòu)及所述代碼注釋，并將所述代碼結(jié)構(gòu)及代碼注釋記錄至源文件中；

s14：依據(jù)預(yù)先設(shè)置的配置文件將所述源文件生成代碼文檔。

可選的，所述方法還包括：

將所述代碼文檔發(fā)布到文檔服務(wù)器上。

可選的，所述將所述代碼文檔發(fā)布到文檔服務(wù)器上的過程具體為：

將所述代碼文檔按照預(yù)設(shè)方式發(fā)布到文檔服務(wù)器上。

可選的，所述預(yù)設(shè)方式為網(wǎng)頁(yè)方式或pdf鏈接的方式。

可選的，所述配置文件包括文檔樣式及文檔風(fēng)格。

為解決上述技術(shù)問題，本發(fā)明實(shí)施例提供了一種持續(xù)集成中的代碼文檔生成裝置，包括：

獲取模塊，用于獲取用戶提交的代碼及代碼注釋；

檢查模塊，用于依據(jù)所述代碼判斷所述代碼注釋是否正確，如果是，則將所述代碼及所述代碼注釋存儲(chǔ)至代碼庫(kù)，并觸發(fā)讀取模塊；否則，返回提示信息；

所述讀取模塊，用于獲取所述代碼的代碼結(jié)構(gòu)及所述代碼注釋，并將所述代碼結(jié)構(gòu)及代碼注釋記錄至源文件中；

文檔生成模塊，用于依據(jù)預(yù)先設(shè)置的配置文件將所述源文件生成代碼文檔。

可選的，還包括文檔發(fā)布模塊，用于將所述代碼文檔發(fā)布到文檔服務(wù)器上。

為解決上述技術(shù)問題，本發(fā)明實(shí)施例提供了一種持續(xù)集成中的代碼文檔生成系統(tǒng)，包括如上述所述的持續(xù)集成中的代碼文檔生成裝置。

本發(fā)明實(shí)施例提供了一種持續(xù)集成中的代碼文檔生成方法、裝置及系統(tǒng)，包括獲取用戶提交的代碼及代碼注釋；依據(jù)代碼判斷代碼注釋是否正確，如果是，則將代碼及代碼注釋存儲(chǔ)至代碼庫(kù)，并執(zhí)行下一步；否則，返回提示信息；獲取代碼的代碼結(jié)構(gòu)及代碼注釋，并將代碼結(jié)構(gòu)及代碼注釋記錄至源文件中；依據(jù)預(yù)先設(shè)置的配置文件將源文件生成代碼文檔。

可見，可以通過對(duì)用戶提交的代碼及代碼注釋進(jìn)行檢驗(yàn)以保證代碼注釋與代碼的一致性，當(dāng)檢驗(yàn)通過后再依據(jù)工作人員提交的代碼的代碼結(jié)構(gòu)及代碼注釋生成源文件，并將源文件按照預(yù)先設(shè)置的配置信息生成代碼文檔。本發(fā)明實(shí)施例在使用過程中實(shí)現(xiàn)了代碼文檔的自動(dòng)生成與及時(shí)更新，并且在一定程度上節(jié)約了人力資源、提高了工作效率及代碼文檔的準(zhǔn)確性。

附圖說明

為了更清楚地說明本發(fā)明實(shí)施例中的技術(shù)方案，下面將對(duì)現(xiàn)有技術(shù)和實(shí)施例中所需要使用的附圖作簡(jiǎn)單地介紹，顯而易見地，下面描述中的附圖僅僅是本發(fā)明的一些實(shí)施例，對(duì)于本領(lǐng)域普通技術(shù)人員來講，在不付出創(chuàng)造性勞動(dòng)的前提下，還可以根據(jù)這些附圖獲得其他的附圖。

圖1為本發(fā)明實(shí)施例提供的一種持續(xù)集成中的代碼文檔生成方法的流程示意圖；

圖2為本發(fā)明實(shí)施例提供的一種持續(xù)集成中的代碼文檔生成裝置的結(jié)構(gòu)示意圖。

具體實(shí)施方式

本發(fā)明實(shí)施例提供了一種持續(xù)集成中的代碼文檔生成方法、裝置及系統(tǒng)，在使用過程中實(shí)現(xiàn)了代碼文檔的自動(dòng)生成與及時(shí)更新，并且在一定程度上節(jié)約了人力資源、提高了工作效率及代碼文檔的準(zhǔn)確性。

為使本發(fā)明實(shí)施例的目的、技術(shù)方案和優(yōu)點(diǎn)更加清楚，下面將結(jié)合本發(fā)明實(shí)施例中的附圖，對(duì)本發(fā)明實(shí)施例中的技術(shù)方案進(jìn)行清楚、完整地描述，顯然，所描述的實(shí)施例是本發(fā)明一部分實(shí)施例，而不是全部的實(shí)施例?；诒景l(fā)明中的實(shí)施例，本領(lǐng)域普通技術(shù)人員在沒有做出創(chuàng)造性勞動(dòng)前提下所獲得的所有其他實(shí)施例，都屬于本發(fā)明保護(hù)的范圍。

請(qǐng)參照?qǐng)D1，圖1為本發(fā)明實(shí)施例提供的一種持續(xù)集成中的代碼文檔生成方法的流程示意圖。

該方法包括：

s11：獲取用戶提交的代碼及代碼注釋；

s12：依據(jù)代碼判斷代碼注釋是否正確，如果是，則將代碼及代碼注釋存儲(chǔ)至代碼庫(kù)，并進(jìn)入s13；否則，返回提示信息；

s13：獲取代碼的代碼結(jié)構(gòu)及代碼注釋，并將代碼結(jié)構(gòu)及代碼注釋記錄至源文件中；

s14：依據(jù)預(yù)先設(shè)置的配置文件將源文件生成代碼文檔。

需要說明的是，開發(fā)人員(及用戶)在進(jìn)行代碼編寫或者代碼更改后，會(huì)將相應(yīng)的代碼以及與該代碼對(duì)應(yīng)的代碼注釋進(jìn)行提交，以將更新后的代碼或者最新編寫的代碼及相關(guān)的代碼注釋存儲(chǔ)至代碼庫(kù)中。由于開發(fā)人員在編寫代碼的過程中可能忘記編寫相應(yīng)的代碼注釋，或者是修改了代碼卻忘記修改相應(yīng)的代碼注釋，所以需要對(duì)開發(fā)人員提交的代碼及代碼注釋進(jìn)行檢驗(yàn)，以確定代碼注釋是否與所提交的代碼一致，進(jìn)一步確保代碼注釋與代碼的同步性。

其中，對(duì)代碼注釋進(jìn)行檢驗(yàn)的過程，具體可以為將代碼注釋與相應(yīng)的代碼進(jìn)行匹配，例如對(duì)相應(yīng)的方法名稱進(jìn)行匹配以便查看代碼注釋中與該方法名稱對(duì)應(yīng)的注釋是否存在，如果存在還可以進(jìn)一步依據(jù)相應(yīng)的參數(shù)檢查該注釋是否正確，當(dāng)確定該代碼注釋正確無誤后將開發(fā)人員提交的代碼以及代碼注釋存儲(chǔ)至代碼庫(kù)中，以對(duì)代碼庫(kù)進(jìn)行更新。當(dāng)然，如果所提交的代碼注釋與所提交的代碼不一致，則可以向用戶返回提示信息，以提示開發(fā)人員對(duì)代碼注釋進(jìn)行完善和修改，然后重新提交代碼及相應(yīng)的代碼注釋。本發(fā)明實(shí)施例中的提示信息可以為代碼注釋錯(cuò)誤和/或請(qǐng)重新提交等提示信息，具體的可以通過提示框或短信息的形式返回提示信息，提示信息的具體類型以及如何返回提示信息本本發(fā)明實(shí)施例對(duì)此不做特殊的限定，能實(shí)現(xiàn)本發(fā)明實(shí)施例的目的即可。

具體的，在將開發(fā)人員提交的代碼以及代碼注釋存儲(chǔ)至代碼庫(kù)后，實(shí)時(shí)獲取所存儲(chǔ)的代碼的代碼結(jié)構(gòu)及代碼注釋，并將該代碼結(jié)構(gòu)和相應(yīng)的代碼注釋寫入到源文件中，從而形成源文件；然后，按照預(yù)先設(shè)置的配置文件將該源文件生成代碼文檔，其中，配置文件可以包括文檔樣式和/或文檔風(fēng)格等，并且配飾文件可以由用戶預(yù)先進(jìn)行設(shè)置，然后將源文件生成為具有相應(yīng)樣式和風(fēng)格的代碼文檔。

進(jìn)行一步，該方法還包括：

將代碼文檔發(fā)布到文檔服務(wù)器上。

需要說明的是，在生成代碼文檔后需要將代碼文檔進(jìn)行發(fā)布，以便于相關(guān)工作人員及時(shí)了解代碼的更新情況，為后續(xù)工作提供依據(jù)。本發(fā)明實(shí)施例中優(yōu)選的，將代碼文檔自動(dòng)發(fā)布到文檔服務(wù)器上，進(jìn)一步提高工作效率。

當(dāng)然，在實(shí)際應(yīng)用中，還可以通過開發(fā)人員將上述生成的代碼文檔發(fā)布出去，具體通過哪種途徑將代碼文檔發(fā)布出去，本發(fā)明實(shí)施例對(duì)此不做特殊的限定，能實(shí)現(xiàn)本發(fā)明實(shí)施例的目的即可。

更進(jìn)一步的，將代碼文檔發(fā)布到文檔服務(wù)器上的過程具體為：

將代碼文檔按照預(yù)設(shè)方式發(fā)布到文檔服務(wù)器上。

具體的，預(yù)設(shè)方式為網(wǎng)頁(yè)方式或pdf鏈接的方式。

需要說明的是，可以按照預(yù)設(shè)方式將代碼文檔發(fā)布到文檔服務(wù)器上，具體可以將代碼文檔以網(wǎng)頁(yè)的方式發(fā)布待文檔服務(wù)器上，即以網(wǎng)頁(yè)的方式在文檔服務(wù)器上呈現(xiàn)出來，或者將代碼文檔按照pdf鏈接的方式發(fā)布到文檔服務(wù)器上，也就是以pdf鏈接的方式在文檔服務(wù)器上呈現(xiàn)出來。

當(dāng)然，本發(fā)明實(shí)施例不僅限于按照上述兩種方式對(duì)代碼文檔進(jìn)行發(fā)布，還可以按照其他的預(yù)設(shè)方式將代碼文檔發(fā)布到服務(wù)器上，具體采用哪種方式，本發(fā)明實(shí)施例對(duì)此不做特殊的限定，能實(shí)現(xiàn)本發(fā)明實(shí)施例的目的即可。

可選的，配置文件包括文檔樣式及文檔風(fēng)格。

具體的，按照預(yù)先設(shè)置的配置文件將源文件生成相應(yīng)的代碼文檔，可以使所生成的代碼文檔具有相應(yīng)的樣式及風(fēng)格，使代碼文檔更加美觀，提高用戶的視覺體驗(yàn)。

另外，本發(fā)明實(shí)施例中的配置文件不僅限于包括上述兩種信息，還可以包括其他的信息，也即對(duì)文檔的其他格式進(jìn)行設(shè)置，具體采用還包括哪種信息，本發(fā)明實(shí)施例對(duì)此不做特殊的限定，能實(shí)現(xiàn)本發(fā)明實(shí)施例的目的即可。

本發(fā)明實(shí)施例提供了一種持續(xù)集成中的代碼文檔生成方法，包括獲取用戶提交的代碼及代碼注釋；依據(jù)代碼判斷代碼注釋是否正確，如果是，則將代碼及代碼注釋存儲(chǔ)至代碼庫(kù)，并執(zhí)行下一步；否則，返回提示信息；獲取代碼的代碼結(jié)構(gòu)及代碼注釋，并將代碼結(jié)構(gòu)及代碼注釋記錄至源文件中；依據(jù)預(yù)先設(shè)置的配置文件將源文件生成代碼文檔。

可見，通過可以對(duì)用戶提交的代碼及代碼注釋進(jìn)行檢驗(yàn)以保證代碼注釋與代碼的一致性，當(dāng)檢驗(yàn)通過后再依據(jù)工作人員提交的代碼及代碼注釋生成源文件，并將源文件按照預(yù)先設(shè)置的配置信息生成代碼文檔。本發(fā)明實(shí)施例在使用過程中實(shí)現(xiàn)了代碼文檔的自動(dòng)生成與及時(shí)更新，并且在一定程度上節(jié)約了人力資源、提高了工作效率及代碼文檔的準(zhǔn)確性。

相應(yīng)的，本發(fā)明實(shí)施例還公開了一種持續(xù)集成中的代碼文檔生成裝置，具體請(qǐng)參照?qǐng)D2，圖2為本發(fā)明實(shí)施例提供的一種持續(xù)集成中的代碼文檔生成裝置的結(jié)構(gòu)示意圖。在上述實(shí)施例的基礎(chǔ)上：

該裝置包括：

獲取模塊1，用于獲取用戶提交的代碼及代碼注釋；

檢查模塊2，用于依據(jù)代碼判斷代碼注釋是否正確，如果是，則將代碼及代碼注釋存儲(chǔ)至代碼庫(kù)，并觸發(fā)讀取模塊3；否則，返回提示信息；

讀取模塊3，用于獲取代碼及代碼注釋，并將代碼及代碼注釋記錄至源文件中；

文檔生成模塊4，用于依據(jù)預(yù)先設(shè)置的配置文件將源文件生成代碼文檔。

可選的，還包括文檔發(fā)布模塊，用于將代碼文檔發(fā)布到文檔服務(wù)器上。

需要說明的是，本發(fā)明實(shí)施例提供的一種持續(xù)集成中的代碼文檔生成裝置，在使用過程中實(shí)現(xiàn)了代碼文檔的自動(dòng)生成與及時(shí)更新，并且在一定程度上節(jié)約了人力資源、提高了工作效率及代碼文檔的準(zhǔn)確性。另外，對(duì)于本發(fā)明實(shí)施例中所涉及到的持續(xù)集成中的代碼文檔生成方法的具體介紹請(qǐng)參照上述方法實(shí)施例，本申請(qǐng)?jiān)诖瞬辉儋樖觥?/p>

在上述實(shí)施例的基礎(chǔ)上，本發(fā)明實(shí)施例提供了一種持續(xù)集成中的代碼文檔生成系統(tǒng)，包括如上述的持續(xù)集成中的代碼文檔生成裝置。

需要說明的是，本發(fā)明實(shí)施例提供的一種持續(xù)集成中的代碼文檔生成系統(tǒng)，在使用過程中實(shí)現(xiàn)了代碼文檔的自動(dòng)生成與及時(shí)更新，并且在一定程度上節(jié)約了人力資源、提高了工作效率及代碼文檔的準(zhǔn)確性。另外，對(duì)于本發(fā)明實(shí)施例中所涉及到的持續(xù)集成中的代碼文檔生成方法的具體介紹請(qǐng)參照上述方法實(shí)施例，本申請(qǐng)?jiān)诖瞬辉儋樖觥?/p>

還需要說明的是，在本說明書中，諸如術(shù)語(yǔ)“包括”、“包含”或者其任何其他變體意在涵蓋非排他性的包含，從而使得包括一系列要素的過程、方法、物品或者設(shè)備不僅包括那些要素，而且還包括沒有明確列出的其他要素，或者是還包括為這種過程、方法、物品或者設(shè)備所固有的要素。在沒有更多限制的情況下，由語(yǔ)句“包括一個(gè)……”限定的要素，并不排除在包括所述要素的過程、方法、物品或者設(shè)備中還存在另外的相同要素。

對(duì)所公開的實(shí)施例的上述說明，使本領(lǐng)域?qū)I(yè)技術(shù)人員能夠?qū)崿F(xiàn)或使用本發(fā)明。對(duì)這些實(shí)施例的多種修改對(duì)本領(lǐng)域的專業(yè)技術(shù)人員來說將是顯而易見的，本文中所定義的一般原理可以在不脫離本發(fā)明的精神或范圍的情況下，在其他實(shí)施例中實(shí)現(xiàn)。因此，本發(fā)明將不會(huì)被限制于本文所示的這些實(shí)施例，而是要符合與本文所公開的原理和新穎特點(diǎn)相一致的最寬的范圍。