這期內(nèi)容當(dāng)中小編將會(huì)給大家?guī)?lái)有關(guān)如何運(yùn)用smalldoc解決Java Web開發(fā)中文檔書寫麻煩的問(wèn)題，文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述，閱讀完這篇文章希望大家可以有所收獲。

創(chuàng)新互聯(lián)建站是一家專注于成都網(wǎng)站設(shè)計(jì)、成都做網(wǎng)站與策劃設(shè)計(jì),夏河網(wǎng)站建設(shè)哪家好?創(chuàng)新互聯(lián)建站做網(wǎng)站,專注于網(wǎng)站建設(shè)十多年,網(wǎng)設(shè)計(jì)領(lǐng)域的專業(yè)建站公司;建站業(yè)務(wù)涵蓋:夏河等地區(qū)。夏河做網(wǎng)站價(jià)格咨詢:18980820575

smalldoc-2.3.1 根據(jù) issues更新如下：

修復(fù)并優(yōu)化 source-paths與 packages配置

source-paths默認(rèn)已經(jīng)給出當(dāng)前項(xiàng)目源碼路徑（即，引入該smalldoc依賴的項(xiàng)目的源碼路徑 —— System.getProperty("user.dir")， 2.3.1修復(fù)了不配置路徑的空指針錯(cuò)誤。

• 只有當(dāng)你需要第三方j(luò)ar包源碼 - 或者你的項(xiàng)目是多模塊項(xiàng)目需要引入其他模塊的源碼，才有必要配置 source-paths。

packages配置Controller類所在的包，會(huì)自動(dòng)遞歸它們子包。如果沒(méi)有指定，默認(rèn)為/，將掃描源碼路徑下所有包，建議給出指定包名，提升解析速度。

遞歸解析返回參數(shù)

無(wú)論你的返回對(duì)象有幾層，都可以顯示在返回參數(shù)表格中，如下圖

支持列表或分頁(yè)接口返回值中List元素結(jié)構(gòu)的解析

修復(fù)*Mapping注解解析異常。

 java.lang.ClassCastException: java.lang.Boolean cannot be cast to [Lcom.sun.javadoc.AnnotationValue;

采用注釋的方式支持參數(shù)是否必須，支持List，Set，數(shù)組，和實(shí)體參數(shù)

• 普通參數(shù)，有且僅在注釋后添加@*表示必須，否則為可選參數(shù)。包括基本類型，基本類型的包裝類型，字符串，以及它們的數(shù)組，List，Set，同時(shí)還有一些庫(kù)類型 —— 例如 File， MultipartFile

• 實(shí)體參數(shù)，實(shí)體類中的所有字段都可能作為參數(shù)被傳遞，而且每個(gè)接口所需要傳遞字段的要求不盡相同，所以我們不可能在 DTO實(shí)體中做標(biāo)記，這樣不僅有代碼侵入性，同時(shí)也不能滿足接口傳參的多樣性。 實(shí)體參數(shù)的注釋，可以使用 @{f1[*],[f2[*],...]} 這種形式來(lái)寫，要么代替整個(gè)注釋，要么放在注釋最后。

• 其中f表示實(shí)體類的某個(gè)字段名，通過(guò)它 ，smalldoc可以去你的實(shí)體類源碼中搜尋參數(shù)的注釋。

• 字段名后添加*表示必須，否則為可選參數(shù)。

• 如果實(shí)體類中的字段沒(méi)有出現(xiàn)在@{}內(nèi)，該字段將不會(huì)作為參數(shù)。

• 如果在@之前還有其它注釋內(nèi)容，將被忽略。

• 如果你的參數(shù)是實(shí)體參數(shù)，注釋結(jié)尾卻不包含該形式，那么將會(huì)打印警告日志，幫你預(yù)先定位該問(wèn)題。

示例如下。

優(yōu)化參數(shù)名展示

優(yōu)化過(guò)后的參數(shù)名支持復(fù)雜數(shù)據(jù)結(jié)構(gòu)，比如關(guān)聯(lián)對(duì)象，關(guān)聯(lián)集合，Set，List或數(shù)組，可直接作為實(shí)際參數(shù)名進(jìn)行接口調(diào)用。

示例代碼

/**
    * 測(cè)試接口
    * @param file 文件
    * @param bb saddas
    * @param cc CCCC
    * @param pp h哈哈是@*
    * @param cca  擦擦擦黑@{authorId*}
    * @param content 內(nèi)容@*
    * @param oaCopyArray  @{authorId*,originalArticleId,categoryId*,paragraph.content}
    * @param oaCopy  @{authorId*,originalArticleId,categoryId*,paragraph.content}
    * @return data-草稿ID
    */
   @RequestMapping("test_path/action2")
   public Result<Long> test(MultipartFile file, Long[] bb , Long cc, List<String> pp, String content, List<OriginalArticleCopy> cca, OriginalArticleCopy[] oaCopyArray, OriginalArticleCopy oaCopy, HttpServletRequest request) {
       return null;
   }

文檔顯示

增加大量斷言

如果你的注釋不規(guī)范，無(wú)法生成合理文檔，smalldoc將打印警告或直接提示異常

支持離線文檔

最初的 smalldoc-antd-react-ui【https://github.com/liuhuagui/smalldoc-antd-react-ui】，采用 React+Fetch 的形式獲得文檔結(jié)構(gòu)，新版本改用 React+模板引擎 寫法，使支持離線文檔，你只需要在瀏覽器中打開文檔UI界面，然后 Ctrl+S 保存離線文件。

上述就是小編為大家分享的如何運(yùn)用smalldoc解決Java Web開發(fā)中文檔書寫麻煩的問(wèn)題了，如果剛好有類似的疑惑，不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識(shí)，歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。

當(dāng)前題目：如何運(yùn)用smalldoc解決JavaWeb開發(fā)中文檔書寫麻煩的問(wèn)題
鏈接分享：http://www.rwnh.cn/article6/pgciig.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供小程序開發(fā)、網(wǎng)站營(yíng)銷、面包屑導(dǎo)航、網(wǎng)頁(yè)設(shè)計(jì)公司、企業(yè)網(wǎng)站制作、網(wǎng)站收錄

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請(qǐng)盡快告知，我們將會(huì)在第一時(shí)間刪除。文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如需處理請(qǐng)聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時(shí)需注明來(lái)源： 創(chuàng)新互聯(lián)