XCODE中如何根据注释生成规范的文档

changechange 2014-06-24 03:09:36

求指导，目前管理IOS的项目，用VVDocumenter-Xcode添加文档注释，但是没有导出这些注释成为html文档的软件，XCODE内置支持HeaderDoc，我发现部分headerdoc的tag与vvdocumenter的tag一样，是否能这样配合起来用？求高手或者有经验的回答一下。

另外，我用 VVDocumenter-Xcode 来自动生成文档是在 .m 文件中写代码，但是 headerdoc是在.h文件中，这个改怎么办？

...全文

165 1 打赏收藏转发到动态举报

写回复

1 条回复

切换为时间正序

请发表友善的回复…

发表回复

LichKingSZ 2014-06-24

打赏
举报

回复

你说的我没有用过，我一般使用Doxygen http://baike.baidu.com/link?url=bwnnu3pJyB1ZGgPDU0HgxlaVHn7UvmAsbbjrpHEqb0NmUJPKEeE_mup5Ug_gwxbAFkaXza8bP53nJ3Jwa4b6h_

很多时候，为了快速开发，很多的技术文档都是能省则省，这个时候注释就变得异常重要，再配合Doxygen这种注释自动生成文档的，就完美了。但是每次都要手动输入规范化的注释，着实也麻烦，但有了VVDocumenter，只需要在要写文档的代码上面连打三个斜杠，就能自动提取参数等生成规范的Javadoc格式文档注释作者也开源了相关代码

SourceDocs SourceDocs是一个命令行工具，可从内联源代码注释生成降价文档文件。与Sphinx或Jazzy相似，SourceDocs解析您的Swift源代码并生成漂亮的SourceDocs SourceDocs是一个命令行工具，可从内联源代码注释生成markdown文档文件。与Sphinx或Jazzy相似，SourceDocs解析您的Swift源代码并生成漂亮的参考文档。与其他工具相比，SourceDocs生成markdown文件，您可以在项目存储库中内联存储和浏览。甚至使用GitHub Pages进行渲染。功能from从Xcode项目生成参考文档:check_mark_button:Ge

这是一门快速入门iOS开发的课程，目的是让大家快速学会，iOS... 项目信息提供完整的Git提交历史，和每节视频一一对应，目前有41次提交，355行注释，271行代码（不包含可视化布局文件，纯Swift和Objective-C代码）。

下载之前请先看一下说明： http://blog.sina.com.cn/s/blog_71715bf80101943f.html

VVDocumenter，只需要在要写文档的代码上面连打三个斜杠，就能自动提取参数等生成规范的Javadoc格式文档注释。

29,027

社区成员

12,466

社区内容

发帖

与我相关

我的任务

社区管理员

加入社区

近7日
近30日
至今

加载中

查看更多榜单

社区公告

暂无公告

试试用AI创作助手写篇文章吧

+ 用AI写文章