headerdoc2html 快速插入注释,[技巧]使用Xcode集成的HeaderDoc自动生成注释和开发文档...
发布日期:2021-08-28 13:15:30 浏览次数:3 分类:技术文章

本文共 839 字,大约阅读时间需要 2 分钟。

Doxygen本来是一个很好的工具,可是我感觉在mac系统下,如果用doxygen最后生成的CHM文件感觉就不是那么恰当,应为本身CHM是微软的产品,苹果系统上并不是很通用,很经常出现文件乱码的情况。这时CHM就比不过PDF和RTF文件。其实直接的html文件也不错。

那在mac平台下没有什么其他的替代方法吗,肯定是有的。特地留意了一下,发现以前真是没有好好的使用xcode强大功能。

HeaderDoc工具

HeaderDoc是一个开源的工具,并且有集成在Xcode中,还有很强大的地方是你可以不用关心注释的格式,或者你可以定制注释的格式和解析的方法。

添加注释的方法是先选中需要添加的注释部分的代码,默认的函数写法需要在+/-号后面和函数名留一个空格。选中需要插入的对应类型的注释,添加说明,不用自己一个一个的写了。

Class header protocol都可以。

fa2e98a7a0fbb8915999c390dc1c36af.png

8acdeddc4cd0e57a24732410e7d2d935.png

如果你知道怎么写脚本,甚至可以定制需要的的类型的注释,比如默认的没有property的注释,你可以自己写一个。也可以自定义快捷键,方便操作。

71da32bfc3541496ff44883bcc2de3fb.png

写好的了注释这就是需要生成可用的帮助文档了

生成文档的方法

用终端进入到头文件所在地文件夹,

》headerdoc2html –o outputDir ExampleHeaders

》gatherheaderdoc outpitDir TOC.Html

outputDir是保存html的文件夹名,ExampleHeaders是保存头文件的地方,TOC.Html是生成的文件名, 都是可以修改的。

运行完就可以在目录下找到TOC.Html,文件这样就可以有一份和Cocoa API Docments一样的文档。虽然还是Html。

4a67127d684a131f1665976f5db1fd26.png

其实还有很多高级的设置,可以支持用户定制格式等,还有支持Man page Generation Language(MPGL) Dialect,这里就不在展开了。具体可以参看苹果的官方的文档HeaderDoc user Guide.

转载地址:https://blog.csdn.net/weixin_33959449/article/details/118349258 如侵犯您的版权,请留言回复原文章的地址,我们会给您删除此文章,给您带来不便请您谅解!

上一篇:php 实现贪吃蛇游戏,php编写的贪吃蛇游戏
下一篇:okgo 缓存html,OKGO 修改缓存数据

发表评论

最新留言

留言是一种美德,欢迎回访!
[***.249.68.22]2022年05月26日 18时09分34秒

关于作者

    喝酒易醉,品茶养心,人生如梦,品茶悟道,何以解忧?唯有杜康!
-- 愿君每日到此一游!

最新文章