我目前正在开发一个项目,我想为其创建帮助文件,但我希望有人可以为此提出最佳实践建议。
帮助文件主要是针对我的,并表示将来可能接管我的项目等的任何人,并且主要会识别我已经实现的对象或代码片段以及它们的用途等的描述。
这是我在苹果开发者库中找到的东西,here但我不确定这是什么或如何使用它..
最佳答案
我更喜欢使用appledoc可以在 GitHub 上找到。
它使用 Doxygen 标记,但以类似于 Apple 文档的格式输出 html、文档集等。
文档集对您很有用,因为您可以将它们安装到 Xcode 中,并在处理代码时直接获得帮助。
关于iphone - 与我的 ios 项目一起创建帮助文件,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/8651640/