Matlab联合wps的API生成文档,自动生成api文档

最近做了一些接口,提供其他人调用,要写个api文档,可是我想代码注释已经写了说明,能不能直接把代码注释生成api?于是找到以下方法

环境:vs2010

先下载安装Sandcastle 和Sandcastle Help File Builder

下载地址

其中Sandcastle Help File Builder安装较复杂,安装红框内的即可

88bdd9e88bba0f1bc302b526d05eb10b.png

安装完成后,然后让要使用的项目输出xml文档文件

a2e846da9dd8b5c8a203a7e30a3a7573.png

ee8ed0ec6d3ed6cf9668e1fc3c7d012c.png

重新生成,能看到输出目录多了这个xml

打开Sandcastle Help File Builder GUI

c91d5e26894a1a65cf7e78054d4d6982.png

在右边的project explorer,加载文档资源

99269279b01ff581f9a34ff2fdc70fc8.png

PS:这里推荐加载上述输出的xml或dll(或exe),虽然加载工程文件(扩展名*.csproj)也行,但在生成文档是使用后者的速度慢很多,不知为何

然后说说 工程属性 的关键几个

这里可以选择不同格式,我选了chm

2e165ccd90dd639b8fd9a292323d2440.png

help file是文档标题,输出文件名,文档语言,表现风格等

3cd6c9d06d482592639a88fcfe86d134.png

visibility比较关键,控制属性哪些项(私有成员,公有成员,方法,属性,构造函数,基类成员,.net基类成员等),还能控制输出我们写的

哪个类,点击【edit API Filter】进入详细控制

f03b9a944dd6746e6fc92ffbe921af1e.png

9c9f8f7007480c4d140591fa6ff3bbec.png

missing tags是是否高亮显示没写的注释,我不想提示,所以大部分没勾

bcb73cb1627418d68fed224ace467342.png

Paths填文件的输出路径

bb5483421a3e2973729947192e6fcc08.png

设置完毕后,开始build

b8625e2a4326d967b6c8d49cb9f4d6b3.png

输出效果

6582cc32d1bee3c39640242b55355827.png

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值