用Doxygen为objective-c代码生成文档

2024-02-08 14:48

本文主要是介绍用Doxygen为objective-c代码生成文档,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

原文见: http://www.dreamingwish.com/dream-2011/use-doxygen-to-generate-documentation-objective-c-code.html


用Doxygen为objective-c代码生成文档



从xcode3升级到xcode4后,那一堆Header Doc选项没了

xcode3的Header Doc加命令行方式生成的文档是基于注释的,而且逻辑整理功能很薄弱。

Doxygen很强大,1.7.5.1版本对objective-c的支持已经很完善了,我们真幸福啊~

简单说说整个流程吧:

到sourceforge上下载dmg,其实我倒更喜欢源码编译方式,那种自由感~

http://sourceforge.net/projects/doxygen/files/rel-1.7.5.1/

加载dmg后,把.app文件拖入应用程序文件夹即可

打开doxygen,先简单设置一下:

Step 1里面选择生成文档的目录

step2里面:

doxygen

project synopsis:工程概述,可以填中文的

Scan recursively:选上,读取所有子文件夹

doxygen

All Entities选上不然生成过程中会有一堆警告,它会跳过哪些没有文档注释的成员等

Include cross-reference…..:太长了懒得打,让文档交叉引用源代码

optimize:优化就选c++吧,没有更好的选择了

doxygen

HTML:生成HTML文档

with navigation panel:加上导航栏吧,挺好用的,就不要选chm,这玩意儿 – -

With search function:搜索功能,多强大的东西,一定要。

LaTeX:这个就不要了,HTML就够了

其他Man pages,RTF,XML在HTML面前都是浮云,Man page么。。也用不着

Diagrams里面就选built-in类图生成器,dot tool很帅,试试也无妨,但是要先安装graphviz。然后在Expert->Dot里面的DOT_PATH里面填/usr/local/bin

doxygen

EXTRACT_PRIVATE和EXTRACT_STATIC:即使选择了EXTRACT_ALL,这俩也需要额外选中,才会生效

EXTARCT_LOCAL_METHODS:这个如果不选中的话,.m文件里面的局域函数不会被解析,类似viewDidLoad这种没有头文件声明的(这个选项可是objective-c专用的)

向下拖动滚动条,还有:

FORCE_LOCAL_INCLUDES:让生成的文档的头文件引用使用双引号而非大于小于号,这个选中吧,大于小于号可是用来引用标准库的

其他超多的选项,自行研究吧 – -


这篇关于用Doxygen为objective-c代码生成文档的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/691344

相关文章

浅谈Redis Key 命名规范文档

《浅谈RedisKey命名规范文档》本文介绍了Redis键名命名规范,包括命名格式、具体规范、数据类型扩展命名、时间敏感型键名、规范总结以及实际应用示例,感兴趣的可以了解一下... 目录1. 命名格式格式模板:示例:2. 具体规范2.1 小写命名2.2 使用冒号分隔层级2.3 标识符命名3. 数据类型扩展命

使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)

《使用Python从PPT文档中提取图片和图片信息(如坐标、宽度和高度等)》PPT是一种高效的信息展示工具,广泛应用于教育、商务和设计等多个领域,PPT文档中常常包含丰富的图片内容,这些图片不仅提升了... 目录一、引言二、环境与工具三、python 提取PPT背景图片3.1 提取幻灯片背景图片3.2 提取

Android实现在线预览office文档的示例详解

《Android实现在线预览office文档的示例详解》在移动端展示在线Office文档(如Word、Excel、PPT)是一项常见需求,这篇文章为大家重点介绍了两种方案的实现方法,希望对大家有一定的... 目录一、项目概述二、相关技术知识三、实现思路3.1 方案一:WebView + Office Onl

Python实现word文档内容智能提取以及合成

《Python实现word文档内容智能提取以及合成》这篇文章主要为大家详细介绍了如何使用Python实现从10个左右的docx文档中抽取内容,再调整语言风格后生成新的文档,感兴趣的小伙伴可以了解一下... 目录核心思路技术路径实现步骤阶段一:准备工作阶段二:内容提取 (python 脚本)阶段三:语言风格调

使用Java将DOCX文档解析为Markdown文档的代码实现

《使用Java将DOCX文档解析为Markdown文档的代码实现》在现代文档处理中,Markdown(MD)因其简洁的语法和良好的可读性,逐渐成为开发者、技术写作者和内容创作者的首选格式,然而,许多文... 目录引言1. 工具和库介绍2. 安装依赖库3. 使用Apache POI解析DOCX文档4. 将解析

Java利用docx4j+Freemarker生成word文档

《Java利用docx4j+Freemarker生成word文档》这篇文章主要为大家详细介绍了Java如何利用docx4j+Freemarker生成word文档,文中的示例代码讲解详细,感兴趣的小伙伴... 目录技术方案maven依赖创建模板文件实现代码技术方案Java 1.8 + docx4j + Fr

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

详解C#如何提取PDF文档中的图片

《详解C#如何提取PDF文档中的图片》提取图片可以将这些图像资源进行单独保存,方便后续在不同的项目中使用,下面我们就来看看如何使用C#通过代码从PDF文档中提取图片吧... 当 PDF 文件中包含有价值的图片,如艺术画作、设计素材、报告图表等,提取图片可以将这些图像资源进行单独保存,方便后续在不同的项目中使

Python实现合并与拆分多个PDF文档中的指定页

《Python实现合并与拆分多个PDF文档中的指定页》这篇文章主要为大家详细介绍了如何使用Python实现将多个PDF文档中的指定页合并生成新的PDF以及拆分PDF,感兴趣的小伙伴可以参考一下... 安装所需要的库pip install PyPDF2 -i https://pypi.tuna.tsingh

Python批量调整Word文档中的字体、段落间距及格式

《Python批量调整Word文档中的字体、段落间距及格式》这篇文章主要为大家详细介绍了如何使用Python的docx库来批量处理Word文档,包括设置首行缩进、字体、字号、行间距、段落对齐方式等,需... 目录关键代码一级标题设置  正文设置完整代码运行结果最近关于批处理格式的问题我查了很多资料,但是都没