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

[技巧]使用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

时间: 2025-01-20 23:31:55

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

eclipse创建servlet时自动生成注释

问题描述 eclipse创建servlet时自动生成注释 eclipse创建servlet时自动生成注释.怎么把那些蓝色绿色的注释关掉? 解决方案 这个应该在代码模板里设置的 解决方案二: response.getWriter().append(""Served at: "").append(request.getContextPath()); 解决方案三: 还自动生成了这行 怎么去掉 解决方案四: 我从来没问过他,直接删除就行了,重新写.注释本身又不影响项目运行.

Eclipse如何自动生成注释

<?xml version="1.0" encoding="UTF-8" standalone="no"?> <templates><template autoinsert="false" context="overridecomment_context" deleted="false" description="Comment for overr

微信公众平台开发文档 生成带参数的二维码

为了满足用户渠道推广分析的需要,公众平台提供了生成带参数二维码的接口.使用该接口可以获得多个带不同场景值的二维码,用户扫描后,公众号可以接收到事件推送. 目前有2种类型的二维码,分别是临时二维码和永久二维码,前者有过期时间,最大为1800秒,但能够生成较多数量,后者无过期时间,数量较少(目前参数只支持1--100000).两种二维码分别适用于帐号绑定.用户来源统计等场景. 用户扫描带场景值二维码时,可能推送以下两种事件: 如果用户还未关注公众号,则用户可以关注公众号,关注后微信会将带场景值关注事

WPS技巧:自动生成人民币大写

  WPS技巧:自动生成人民币大写        开支票.写工资单通常要把数值转换为人民币大写格式.若Excel通过设置公式的方法会十分麻烦.用WPS表格来转换只需选择要修改的文本,工具栏上找到格式按钮,并选择单元格格式. 在出现弹窗中数字选项卡中选择"特殊"分类中的"人民币大写",点击"确定"就OK啦!

php的扩展自动生成

扩展生成 毫无疑问你已经注意到, 每个php扩展都包含一些非常公共的并且非常单调的结构和文件. 当开始一个新扩展开发的时候, 如果这些公共的结构已经存在, 我们只用考虑填充功能代码是很有意义的. 为此, 在php中包含了一个简单但是很有用的shell脚本. ext_skel 切换到你的php源代码树下ext/目录中, 执行下面的命令: jdoe@devbox:/home/jdoe/cvs/php-src/ext/$ ./ext_skel extname=sample7   稍等便可, 输出一些文

关于我的自动生成编号的方法(来这么久,第一次写个人的编程技巧,不知能不能上精华)

编程|技巧|精华 前言:    用过许多序号的方法,indentity 或 new id() ,都不好用,自己写了一个,这个序号的特点是:每次取相应表中的系统当天最大序号,如果当天无记录,则自动生成一个当天序号 1.建种子表,这个表用来保存各个表目前已使用到的最大序号--种子表create table SEED (BM  varchar(20) not null,   --表名BH   varchar(12) not null,   --种子编号constraint PK_SEED primar

Word文档中自动生成章节号技巧

在Word文档中,若要在标题的前面自动生成章节号,比如"第X章","1.1"等,需要对标题进行大纲等级设置,具体的设置请参见"样式的设置".在标题设置好后依次点击菜单栏的格式-项目符号和编号打开项目符号和编号对话框,再选择多级符号选项卡. 可以任选一个多级符号样式进行进一步的设置,在本文中我选择第二个样式进行进一步的设置.点击多级符号选项卡的自定义,打开自定义多级符号列表对话框. 从对话框继续点击高级后可以看到,我们能对编号的各个属性进行设置,在

word2013自动生成目录的两种技巧

  自动生成目录的方法一: 步骤一:首先插入一码"插入→页码";"布局→分隔符→下一页",也就是前面空出一页. 步骤二:选择"视图→大纲视图" 步骤三:文本变成如下图所示 步骤四:选定要作为一级目录的文字,再选择"一级目录"如下图 步骤五:同理选定要作为二级目录的文字,再选择"二级目录",三级目录的也一样.作为正文的选择"正文文本" 步骤六:最后自动生成目录. 自动生成目录的方法二: 步

php实现根据url自动生成缩略图的方法_php技巧

本文实例讲述了php实现根据url自动生成缩略图的方法,是非常实用的功能.分享给大家供大家参考.具体方法如下: 原理:设置apache rewrite ,当图片不存在时,调用php创建图片. 例如: 原图路径为:http://localhost/upload/news/2013/07/21/1.jpg 缩略图路径为:http://localhost/supload/news/2013/07/21/1.jpg 当访问 http://localhost/supload/news/2013/07/21