我目前正在从事一个项目，我想为其创建帮助文件，但我希望有人可以为此建议最佳做法。
帮助文件主要是给我的，说将来可能会接管我的项目等的任何人，并且主要会识别我已经实现的对象或代码片段以及它们的用途描述等。
这是我在苹果开发者库中找到的，here，但我不确定这是什么或如何使用它..
【问题讨论】：
我更喜欢使用 GitHub 上提供的appledoc。
它使用 Doxygen 标记，但以类似于 Apple 文档的格式输出 html、docsets 等。
Docsets 对您很有用，因为您可以将它们安装到 Xcode 中，并在处理代码时直接获得帮助。
【讨论】：
我决定使用 Apples HeaderDocs，因为它已经内置在它生成的结果与使用上面列出的应用程序创建的结果非常相似（re: html 输出）
它很简单，因为您只需在标题标签中使用结构化的 cmets
/*!
@class myclass
@discussion enter any text here that can span multiple lines etc
*/
您可以评论方法、函数、类、参数等，这真是太棒了。
然后，当您使用收集的标头脚本在 cmd 行中编译标头时，它会将您的所有标头 cmets 组合到您指定的目录中的 MasterDoc.html 中
>headerdoc2html -o outputdir ExampleHeaders
>gatherheaderdoc outputdir
这种记录风格非常适合我个人，因为我喜欢对我的代码进行大量注释，但是我缺乏现在这将为我的 cmets 带来的结构，所以它真的是一块石头杀死两只鸟。
唯一让我失望的是它可能不像本文之前列出的那样灵活......所以是的，我猜用户偏好......现在开始了解更多
【讨论】：
你看过 doxygen 吗？它支持多种语言，并且由于它直接从源代码中选择 cmets，因此您的帮助文档和源代码更有可能始终保持同步。
Doxygen 开箱即用地支持 C++、C 和 Objective-C。
我个人发现，如果您从良好的 doxygen 文档开始，其他开发人员更有可能接受并保持最新。
【讨论】：