一種基于代碼注釋自動(dòng)生成開發(fā)文檔的方法及系統(tǒng)

基本信息

申請(qǐng)?zhí)?/td> CN201911048944.5 申請(qǐng)日 -
公開（公告）號(hào) CN110764820A 公開（公告）日 2020-02-07
申請(qǐng)公布號(hào) CN110764820A 申請(qǐng)公布日 2020-02-07
分類號(hào) G06F8/73;G06F9/445;G06F16/93 分類 計(jì)算；推算；計(jì)數(shù);
發(fā)明人 郭兆東 申請(qǐng)（專利權(quán)）人 百卓網(wǎng)絡(luò)科技有限公司
代理機(jī)構(gòu) 南京瑞弘專利商標(biāo)事務(wù)所（普通合伙） 代理人 百卓網(wǎng)絡(luò)科技有限公司
地址 210000 江蘇省南京市江北新區(qū)惠達(dá)路6號(hào)北斗大廈2號(hào)樓70室
法律狀態(tài) -

摘要

摘要 本發(fā)明公開了一種基于代碼注釋自動(dòng)生成開發(fā)文檔的方法及系統(tǒng)，其特征在于，包括如下步驟：安裝webpack和react?styleguidist用于構(gòu)建項(xiàng)目；在webpack配置文件同級(jí)目錄下新建并配置styleguide.config.js文件，對(duì)項(xiàng)目的組件進(jìn)行分類，將需要對(duì)外暴露的組件放在views目錄下，通過通配符select*獲取.jsx文件；通過包裹文件從項(xiàng)目中引入公共樣式和特殊樣式，對(duì)antd組件庫進(jìn)行全局設(shè)置，集成redux數(shù)據(jù)；在package.json中配置腳本；在webpack配置中通過env環(huán)境變量來分別給不同的環(huán)境添加設(shè)定不同的接口地址，再通過代理來正常訪問接口。達(dá)到可以通過組件的代碼注釋自動(dòng)生成，為各種使用場(chǎng)景編寫demo以及對(duì)應(yīng)的說明，同時(shí)附上demo源碼，可以修改源碼，實(shí)時(shí)預(yù)覽demo的效果。