iOS项目自动生成技术文档的认识.docVIP

iOS项目自动生成技术文档 做项目一般都会要求写技术文档，特别是单干接项目的，客户多少都会要求除了提供code之外，还得提供技术文档，而如果我们手写这类的文档，那工作量不比写code少。一般的开发工具都会提供类似集成的功能，比如Java语言本身就自带javadoc命令，可以从源码中抽取文档，几个配置，几条命令就搞定了。 Xcode工具本身不具备这样的功能，但是我们通过一些插件和工具来达到这个目的。 生成注释 生成文档之前，我们需要给代码中的方法或者变量写上注释，然后再利用工具根据这些规范的注释自动生成文档。所以呢，注释一定要规范统一，但是每次都要手动输入规范化的注释，着实也麻烦，这里需要借助Xcode的开源插件VVDocumenter，规范注释生成器，非常方便！ 多行注释直接输入三个斜线 /// 会自动格式化，如上图所示 单行注释需要输入三个斜线+空格 “/// 注释”。输入两个“//”当然可以正确的被xcode识别为注释，但是在下面生成文档的时候不能被识别为文档注释。 然后再配合?appledoc?、doxygen?或者?headdoc，就可以生成技术文档。 对于Objective-C来说，目前比较好用的是appledoc?和?doxygen。 工具对比 headerdocxcode 自带的文档生成工具、基于命令行的操作、使用方便。但是只能生成以 /*!