[发明专利]一种基于代码注释自动生成开发文档的方法及系统在审
| 申请号： | 201911048944.5 | 申请日： | 2019-10-31 |
| 公开（公告）号： | CN110764820A | 公开（公告）日： | 2020-02-07 |
| 发明（设计）人： | 郭兆东 | 申请（专利权）人： | 百卓网络科技有限公司 |
| 主分类号： | G06F8/73 | 分类号： | G06F8/73;G06F9/445;G06F16/93 |
| 代理公司： | 32249 南京瑞弘专利商标事务所(普通合伙) | 代理人： | 陈建和 |
| 地址： | 210000 江苏省南京市*** | 国省代码： | 江苏;32 |
| 权利要求书： | 查看更多 | 说明书： | 查看更多 |
| 摘要： | 本发明公开了一种基于代码注释自动生成开发文档的方法及系统，其特征在于，包括如下步骤：安装webpack和react‑styleguidist用于构建项目；在webpack配置文件同级目录下新建并配置styleguide.config.js文件，对项目的组件进行分类，将需要对外暴露的组件放在views目录下，通过通配符select\*获取.jsx文件；通过包裹文件从项目中引入公共样式和特殊样式，对antd组件库进行全局设置，集成redux数据；在package.json中配置脚本；在webpack配置中通过env环境变量来分别给不同的环境添加设定不同的接口地址，再通过代理来正常访问接口。达到可以通过组件的代码注释自动生成，为各种使用场景编写demo以及对应的说明，同时附上demo源码，可以修改源码，实时预览demo的效果。 | ||
| 搜索关键词： | 代码注释 自动生成 源码 样式 访问接口 环境变量 接口地址 配置脚本 配置文件 全局设置 使用场景 通配符 组件库 构建 文档 预览 配置 代理 引入 暴露 分类 开发 | ||
【主权项】：
1.一种基于代码注释自动生成开发文档的方法，其特征在于，包括如下步骤：/n步骤1：安装文档生成器，具体为安装webpack和react-styleguidist用于构建项目；/n步骤2：配置相关配置文件，在webpack配置文件同级目录下新建并配置styleguide.config.js文件，通过sections参数对项目的组件进行分类，将需要对外暴露的组件放在views目录下，views目录下的每一个文件只能暴露一个组件，通过通配符select\*获取.jsx文件；/n步骤3：配置外层包裹文件，具体为通过包裹文件从项目中引入公共样式和特殊样式，对antd组件库进行全局设置，集成redux数据；/n步骤4：配置发布脚本，具体为在package.json中配置脚本，所述配置脚本包括文档的开发环境和生产环境；对于向后端请求数据的组件，通过在package.json中添加env环境变量，在webpack配置中通过env环境变量来分别给不同的环境添加设定不同的接口地址，再通过代理来正常访问接口。/n
下载完整专利技术内容需要扣除积分，VIP会员可以免费下载。
该专利技术资料仅供研究查看技术是否侵权等信息，商用须获得专利权人授权。该专利全部权利属于百卓网络科技有限公司，未经百卓网络科技有限公司许可，擅自商用是侵权行为。如果您想购买此专利、获得商业授权和技术合作，请联系【客服】
本文链接：http://www.vipzhuanli.com/patent/201911048944.5/，转载请声明来源钻瓜专利网。
