一种基于代码注释自动生成开发文档的方法及系统专利查询专利号|摘要-满商公司网

一种基于代码注释自动生成开发文档的方法及系统

基本信息

申请号	CN201911048944.5	申请日	-
公开（公告）号	CN110764820A	公开（公告）日	2020-02-07
申请公布号	CN110764820A	申请公布日	2020-02-07
分类号	G06F8/73;G06F9/445;G06F16/93	分类	计算；推算；计数;
发明人	郭兆东	申请（专利权）人	百卓网络科技有限公司
代理机构	南京瑞弘专利商标事务所（普通合伙）	代理人	百卓网络科技有限公司
地址	210000 江苏省南京市江北新区惠达路6号北斗大厦2号楼70室
法律状态	-

摘要

本发明公开了一种基于代码注释自动生成开发文档的方法及系统，其特征在于，包括如下步骤：安装webpack和react‑styleguidist用于构建项目；在webpack配置文件同级目录下新建并配置styleguide.config.js文件，对项目的组件进行分类，将需要对外暴露的组件放在views目录下，通过通配符select*获取.jsx文件；通过包裹文件从项目中引入公共样式和特殊样式，对antd组件库进行全局设置，集成redux数据；在package.json中配置脚本；在webpack配置中通过env环境变量来分别给不同的环境添加设定不同的接口地址，再通过代理来正常访问接口。达到可以通过组件的代码注释自动生成，为各种使用场景编写demo以及对应的说明，同时附上demo源码，可以修改源码，实时预览demo的效果。