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