appledoc
2.2.1 build 1333
重要通知：需要合作者
appledoc 是命令行工具，可帮助 Objective-C 开发人员从特殊格式的源代码注释生成类似 Apple 的源代码文档。它的设计目的是为了输入尽可能可读的源代码注释，并使用注释以及周围的源代码来生成 HTML 形式的视觉上吸引人的文档以及完全索引和可浏览的 Xcode 文档集。尽管有多种工具可以为 Objective-C 创建 HTML 文档，但据我所知，所有这些工具都无法满足下面描述的最低目标。
appledoc 的主要目标：
为了让您尽可能顺利地使用 appledoc，我们强烈建议您阅读整个文档以及下面“使用 appledoc”部分中提到的所有在线文档！
根据本文件底部“许可证”部分列出的条款，允许使用 appledoc！
想要保持更新吗？在 Twitter 上关注我们 - @gentlebytes。
推荐的方法是克隆 GitHub 项目并从 Xcode 编译该工具。由于克隆 GitHub 项目将创建主存储库的链接，因此它也极大地简化了未来的升级。要安装，请在终端中键入以下内容：
git clone git://github.com/tomaz/appledoc.git
这将创建 appledoc 目录。在其中您可以找到 appledoc.xcworkspace Xcode 工作区；打开它并编译 appledoc 目标 - 这应该可以开箱即用，但是您的系统必须满足最低系统要求，请参见下文。我建议您将生成的 appledoc 可执行文件从构建目录复制到路径中的目录之一（ echo $PATH ），以使其易于访问。
可选：Appledoc 是独立的，包含必要的模板文件。如果您想将这些默认值从 Templates 子目录修改到预期位置之一：
您还可以使用 install-appledoc.sh 脚本来执行快速安装。打开终端并切换到 appledoc 目录。键入以下命令：
sudo sh install-appledoc.sh (if you need templates add '-t default')
默认情况下，它编译 appledoc 并将其二进制文件安装到 /usr/local/bin 并将模板（如果需要）安装到 ~/.appledoc 。您可以分别使用 -b 和 -t 选项覆盖此目录。例如：
sudo sh install-appledoc.sh -b /usr/bin -t ~/Library/Application Support/appledoc
或者使用自制程序：
brew install appledoc
Homebrew 默认不安装模板。
使用appledoc --help查看所有命令行开关的列表。在 appledoc 网站上阅读有关 appledoc 的更多信息。另请阅读 wiki 页面以获取一些更深入的文章。
使用 appledoc Google 群组作为有关使用问题或其他一般问题的论坛。
使用 appledoc 问题页面提交错误和功能请求。在提交新问题之前，请检查论坛，看看您的问题是否在那里得到解答 - 除非您可以确认您的问题是新功能请求或错误，否则您应该从论坛开始，以保持 GitHub 问题的干净。另请仔细阅读问题，看看该问题是否已经存在，并对其进行投票或添加评论（不要忘记已关闭的问题）。
要保持最新状态，只需转到终端并 cd 进入 appledoc 目录，发出git pull并重新编译 appledoc.xcodeproj。不要忘记覆盖您复制到 $PATH 的 appledoc 可执行文件:)
如果您还想编译并运行 AppledocTests（单元测试）目标，则需要在构建单元测试目标之前将 Libraries & Frameworks 组中指示的所有框架复制到共享框架目录！这对于构建 appledoc 工具本身来说不是必需的。
您可以设置 Xcode 来自动创建 appledoc 文档。了解如何使用运行脚本和项目的构建阶段。
大多数 Cocoa 框架的预生成文档和文档集可在以下位置找到：
拥有文档集后，您可能希望将其与文档浏览器一起使用：
有问题吗？您可以执行以下操作来排除故障：
git pull并再次使用最新版本运行。--verbose命令行开关增加详细级别。默认级别为 2，但您可以逐步将详细程度增加到 6，每个级别都会为您提供更详细的信息。由于这将为您提供更多信息，因此您可能只想专注于遇到问题的特定源文件集。请注意，增加详细程度会导致性能下降，因此不建议每天使用高于 4 的级别。如果您希望做出贡献，请参阅开发人员说明文件，以获取有关 appledoc 内部工作原理的简短概述。
appledoc 已获得修改后的 BSD 许可证的许可。用简单的语言来说：您可以对代码做任何您想做的事情，修改，重新分发，嵌入您的产品（免费或商业），但您必须包含许可证中规定的版权，使用条款和免责声明，同样与任何其他 BSD 许可代码一样。您当然可以使用 appledoc 为您的产品生成的文档（免费或商业），但您必须在文档本身或其他适当的位置（例如您的网站）中注明 appledoc。
如果出于某种原因您无法同意这些条款，请通过我们的“关于”页面上的联系表与我们联系，我们将尽力帮助您并找到可行的解决方案！
版权所有 (c) 2009-2011，Gentle Bytes 保留所有权利。
如果满足以下条件，则允许以源代码、二进制形式和生成的文档（无论是否经过修改）重新分发和使用：
源代码的重新分发必须保留上述版权声明、此条件列表和以下免责声明。
以二进制形式重新分发必须在随分发提供的文档和/或其他材料中复制上述版权声明、此条件列表以及以下免责声明。
由 appledoc 生成的文档的重新分发必须包含 appledoc 的归属，无论是在文档本身还是其他适当的媒体中。
未经事先书面许可，不得使用 appledoc、Gentle Bytes 及其贡献者的名称来认可或推广源自本软件的产品。
本软件由版权所有者和贡献者“按原样”提供，不承担任何明示或默示的保证，包括但不限于适销性和特定用途适用性的默示保证。在任何情况下，版权持有者或贡献者均不对任何直接、间接、附带、特殊、惩戒性或后果性损害（包括但不限于采购替代商品或服务；使用、数据或利润损失；或其他损失）承担责任。或商业中断），无论是何种原因造成的，并且基于任何责任理论，无论是合同责任、严格责任还是侵权行为（包括疏忽或其他），均因使用本软件而产生，即使已被告知可能发生此类损害。
温和字节 [email protected]
