這期內(nèi)容當(dāng)中小編將會給大家?guī)碛嘘P(guān)如何運用smalldoc解決Java Web開發(fā)中文檔書寫麻煩的問題,文章內(nèi)容豐富且以專業(yè)的角度為大家分析和敘述,閱讀完這篇文章希望大家可以有所收獲。
創(chuàng)新互聯(lián)建站是一家專注于成都網(wǎng)站設(shè)計、成都做網(wǎng)站與策劃設(shè)計,夏河網(wǎng)站建設(shè)哪家好?創(chuàng)新互聯(lián)建站做網(wǎng)站,專注于網(wǎng)站建設(shè)十多年,網(wǎng)設(shè)計領(lǐng)域的專業(yè)建站公司;建站業(yè)務(wù)涵蓋:夏河等地區(qū)。夏河做網(wǎng)站價格咨詢:18980820575
smalldoc-2.3.1
根據(jù) issues更新如下:
source-paths默認(rèn)已經(jīng)給出當(dāng)前項目源碼路徑(即,引入該smalldoc依賴的項目的源碼路徑 —— System.getProperty("user.dir")
, 2.3.1
修復(fù)了不配置路徑的空指針錯誤。
只有當(dāng)你需要第三方j(luò)ar包源碼 - 或者你的項目是多模塊項目需要引入其他模塊的源碼,才有必要配置 source-paths。
packages配置Controller類
所在的包,會自動遞歸它們子包。如果沒有指定,默認(rèn)為/
,將掃描源碼路徑下所有包,建議給出指定包名,提升解析速度。
無論你的返回對象有幾層,都可以顯示在返回參數(shù)表格中,如下圖
*Mapping注解
解析異常。java.lang.ClassCastException: java.lang.Boolean cannot be cast to [Lcom.sun.javadoc.AnnotationValue;
普通參數(shù),有且僅在注釋后添加@*
表示必須,否則為可選參數(shù)。包括基本類型,基本類型的包裝類型,字符串,以及它們的數(shù)組,List,Set,同時還有一些庫類型
—— 例如 File, MultipartFile
實體參數(shù),實體類中的所有字段都可能作為參數(shù)被傳遞,而且每個接口所需要傳遞字段的要求不盡相同,所以我們不可能在 DTO實體中做標(biāo)記,這樣不僅有代碼侵入性,同時也不能滿足接口傳參的多樣性。 實體參數(shù)的注釋,可以使用 @{f1[*],[f2[*],...]}
這種形式來寫,要么代替整個注釋,要么放在注釋最后。
其中f
表示實體類的某個字段名,通過它 ,smalldoc可以去你的實體類源碼中搜尋參數(shù)的注釋。
字段名后添加*
表示必須,否則為可選參數(shù)。
如果實體類中的字段沒有出現(xiàn)在@{}
內(nèi),該字段將不會作為參數(shù)。
如果在@
之前還有其它注釋內(nèi)容,將被忽略。
如果你的參數(shù)是實體參數(shù),注釋結(jié)尾卻不包含該形式,那么將會打印警告日志,幫你預(yù)先定位該問題。
示例如下。
優(yōu)化過后的參數(shù)名支持復(fù)雜數(shù)據(jù)結(jié)構(gòu),比如關(guān)聯(lián)對象,關(guān)聯(lián)集合,Set,List或數(shù)組,可直接作為實際參數(shù)名進(jìn)行接口調(diào)用。
示例代碼
/** * 測試接口 * @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 Resulttest(MultipartFile file, Long[] bb , Long cc, List pp, String content, List cca, OriginalArticleCopy[] oaCopyArray, OriginalArticleCopy oaCopy, HttpServletRequest request) { return null; }
文檔顯示
如果你的注釋不規(guī)范,無法生成合理文檔,smalldoc將打印警告或直接提示異常
最初的 smalldoc-antd-react-ui【https://github.com/liuhuagui/smalldoc-antd-react-ui】,采用 React+Fetch
的形式獲得文檔結(jié)構(gòu),新版本改用 React+模板引擎
寫法,使支持離線文檔,你只需要在瀏覽器中打開文檔UI界面,然后 Ctrl+S
保存離線文件。
上述就是小編為大家分享的如何運用smalldoc解決Java Web開發(fā)中文檔書寫麻煩的問題了,如果剛好有類似的疑惑,不妨參照上述分析進(jìn)行理解。如果想知道更多相關(guān)知識,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。