如何在目标C中进行文档记录?[关闭]

它附带Xcode,所以不需要安装。它附带了一个命令行脚本,可以生成文档的HTML输出。

总部文件:

• 简介
• headerDoc命令行工具
• headerDoc标记

举个例子:

大优点:当你点击你的文档方法时,你的文档会出现在气球里:

HeaderDoc也是开源的: http://www.open source.apple.com/source/headerDoc/

它附带Xcode,所以不需要安装。它附带了一个命令行脚本,可以生成文档的HTML输出。

总部文件:

• Introduction
• HeaderDoc command-line tool
• HeaderDoc markup

下面是一个例子:

/*!
 *  Takes in a number and adds 4 to it.
 *
 *  @param myNumber a number of type NSInteger.
 *
 *  @return The number with 4 added to it.
 */
- (NSInteger)addFour:(NSInteger)myNumber {
    return myNumber + 4;
}

大优点:当你点击你的记录方法时,你的文档会出现在气球里:

HeaderDoc也是开源的: http://www.opensource.apple.com/source/headerdoc/