AppleDoc 介绍

各大技术博客网站对此都有介绍,此处引用简书的一篇文章:appledoc

除了“sy随缘”所说的appledoc能根据代码注释生成API文档外,还有另外一个作用,那就是检查代码中注释不规范的地方。如果代码注释不规范,appledoc将会在跑脚本的时候报错,详细的报错日志会展示哪个类、哪一行有注释问题。这个在使用过程中就会发现。

一般技术博客都会介绍如何生成html文档,但ta有个很大的缺陷,那就是不支持搜索,因为这个,基本上没人会用ta了。今天这里将介绍一种方法,来解决这个问题,让appledoc真实的帮助我们规范化代码,高效使用API文档。

解决问题的关键在于生成appledoc的脚本,脚本的正确姿势见AppleDoc 使用介绍,这个脚本除了生成html文档,还会生成docset文件。苹果官方提供的API也是这种格式。使用Dash下载Apple的官方文档,右键show in finder就可以看到“Apple_API_Reference.docset”。

安装好Dash,生成docset文件,双击用Dash打开后就可以进行模糊搜索了

AppleDoc 介绍

AppleDoc 介绍

AppleDoc 介绍

AppleDoc 介绍

上一篇:axios请求使用


下一篇:windows7 配置opencv for python开发环境