iOS项目自动生成技术文档.docx

iOS项目自动生成技术文档 做项目一般都会要求写技术文档，特别是单干接项目的，客户多少都会要求除了提供 code 之外，还得提供技术文档，而如果我们手写这类的文档，那工作量不比写 code少。一般的 开发工具都会提供类似集成的功能，比如 Java语言本身就自带javadoc命令，可以从源码 中抽取文档，几个配置，几条命令就搞定了。 Xcode工具本身不具备这样的功能，但是我们通过一些插件和工具来达到这个目的。 生成注释 生成文档之前，我们需要给代码中的方法或者变量写上注释， 然后再利用工具根据这些规范 的注释自动生成文档。 所以呢，注释一定要规范统一， 但是每次都要手动输入规范化的注释， 着实也麻烦，这里需要借助 Xcode的开源插件 VVDocumenter ,规范注释生成器，非常方 便！ (BOOL)loadFrcwpContent3： Cidjcontents ofType: (NSStri n^： errors **)outError if ([cq?itents length] > 0)￡ self.noteContent = [[NSString allocj initWithBytes:[contents bytes] length：[contents length! encod ing:NSUTFSStr l ngEncodin^J; } else ( // When the note Is First created, assign defau11 content seif+notecontent = ; } [(NSHotonCenter defaultCentcr] postNotificationName^ ' . ■ m.： objects self]; 多行注释直接输入三个斜线 "///"会自动格式化，如上图所示 单行注释需要输入三个斜线 +空格 "/〃注释”。输入两个“/咨'然可以正确的被 xcode识别为 注释，但是在下面生成文档的时候不能被识别为文档注释。 然后再配合 appledoc、doxygen或者headdoc ,就可以生成技术文档。 对于Objective-C 来说，目前比较好用的是 appledoc和doxygen 。 工具对比 headerdoc xcode自带的文档生成工具、基于命令行的操作、使用方便。但是只能生成以 /*! */的格 式的注释。还有一个缺点是每个类文件对应一个注释文件， 没有最后汇总导航的index文件。 docxygen 功能强大、三者中支持语言最多的、无 headerdoc缺点、基于图形化的操作界面，但是配 置较多，可以生成 html文档或pdf文档。 appledoc 基于命令行的操作、使用方便、无 headerdoc缺点、默认生成的文档风格和苹果的官方文 档是一致的，即docset ,集成到xcode中就跟苹果的官方文档一模一样， 在源码中按住option 再单击就可以调出相应方法的帮助。当然也可以生成 html文档。 工具使用 appledoc 从github下载源码，在终端里面 cd源码文件夹，然后执行 shell脚本安装 | [plain] view plaincopy I~ git clone git:///tomaz/appledoc.git cd appledoc sudo sh install-appledoc.sh 安装过程中如果出错，检查一下 Xcode所在的路径中是否存在空格，去掉再试之。 成功后在终端cd到项目文件夹里面，输入以下命令生成文档： [plain] view plaincopy 1. appledoc --output ../doc --project-name weibo --project-company "wxhl" --com pany-id "com.wxhl.weibo". --output ../doc 设置文档输出目录为上级目录下面的 doc --project-name weibo 设置项 目名为 "weibo” --project-company "wxhl" 设置公司名为 "wxhl” --company-id "com.wxhl.weibo" 设置公司 id 为"com.wxhl.weibo ” .当前目录 当该命令完成后，可以看到在上级目录的 doc文件夹里面有一个 docset-installed.txt的文件, 这里面描述了 docset文档所在的真正路径，一般都是在? /Library/Developer/Shared/Documentation/DocSets/ -Documentation ,会发现其中新增了帮助文档。 里面，或者看看 xcode 中的 Organizer 里面，或