[技巧]使用Xcode集成的HeaderDoc自动生成注释和开发文档

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

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

HeaderDoc工具

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

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

Class header protocol都可以。

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

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

生成文档的方法

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

》headerdoc2html –o outputDir ExampleHeaders

》gatherheaderdoc outpitDir TOC.Html

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

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

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

转载于:https://blog.51cto.com/arthurchen/708188

[技巧]使用Xcode集成的HeaderDoc自动生成注释和开发文档相关推荐

DotNet 项目开发文档的自动生成和相关工具的使用
在 VS.Net 的 IDE 中对C#提供了一些可以自动生成的 XML 注释,使用这些注释可以对代码中定义的对象进行说明.注解:通过设置项目属性,在生成项目时,可以让VS.Net自动的将这些注释信息输 ...
在idea中为类和方法自动生成注释
一.设置类级别的注释(创建类是自动生成注释) 二.设置方法级别的注释一.设置类级别的注释(创建类是自动生成注释) 图中的代码块: /** * @author ${USER} * @date ${DA ...
.NET6使用DOCFX根据注释自动生成开发文档
本文内容来自我写的开源电子书<WoW C#>,现在正在编写中,可以去WOW-Csharp/学习路径总结.md at master · sogeisetsu/WOW-Csharp (gith ...
eclipse类自动生成注释
1.创建新类时自动生成注释 window->preference->java->code styple->code template 当你选择到这部的时候就会看 ...
在 idea 中为类和方法自动生成注释
前些天发现了一个巨牛的人工智能学习网站,通俗易懂,风趣幽默,忍不住分享一下给大家.点击跳转到教程. 项目规范中有一项常见的要求,在类级和方法级注释里写上创建者和创建时间,在方法级注释里写上创建者和维护 ...
生成注释_SOLIDWORKS DimXpert 自动生成注释
SOLIDWORKS DimXpert 可帮助您准备模型供转换到工程图或用于 TolAnalyst™ 中.DimXpert 通过在诸如孔和槽口之类的制造特征中自动或手工插入尺寸和公差而运转,今天我们就 ...
c++注释快捷键_是不是晚了点：Visual Studio可以自动生成注释啦!
蝎子如果你正在使用Doxygen或者XML文档注释,那么Visual Studio v16.6 Preview 2了一项称之为注释自动生成(automatic comment stub genera ...
MyEclipse自动生成注释，修改注释模板
以下学习过程中的笔记,部分内容来自网络和书籍.一方便以后查阅,二希望能帮助到别人,三希望高手指点. 用Myeclipse开发项目是,自动生成注释十分方便快捷,但我们希望自动生成自己的名字和一些内容,同 ...
程序员幸福感拉满：一键为代码自动生成注释的工具，拿走不谢！
提升程序员幸福感的CodeGeeX代码解释功能上线了! 一个"古老的传说":程序员最讨厌的2件事:一是编写程序时要写注释,二是看别人编写的程序里没写注释: 可见,手动为代码添加注释 ...

[技巧]使用Xcode集成的HeaderDoc自动生成注释和开发文档

[技巧]使用Xcode集成的HeaderDoc自动生成注释和开发文档相关推荐

最新文章

热门文章