用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

相关文章

C#实现一键批量合并PDF文档

《C#实现一键批量合并PDF文档》这篇文章主要为大家详细介绍了如何使用C#实现一键批量合并PDF文档功能,文中的示例代码简洁易懂,感兴趣的小伙伴可以跟随小编一起学习一下... 目录前言效果展示功能实现1、添加文件2、文件分组(书签)3、定义页码范围4、自定义显示5、定义页面尺寸6、PDF批量合并7、其他方法

Java实现在Word文档中添加文本水印和图片水印的操作指南

《Java实现在Word文档中添加文本水印和图片水印的操作指南》在当今数字时代,文档的自动化处理与安全防护变得尤为重要,无论是为了保护版权、推广品牌,还是为了在文档中加入特定的标识,为Word文档添加... 目录引言Spire.Doc for Java:高效Word文档处理的利器代码实战:使用Java为Wo

使用Python实现Word文档的自动化对比方案

《使用Python实现Word文档的自动化对比方案》我们经常需要比较两个Word文档的版本差异,无论是合同修订、论文修改还是代码文档更新,人工比对不仅效率低下,还容易遗漏关键改动,下面通过一个实际案例... 目录引言一、使用python-docx库解析文档结构二、使用difflib进行差异比对三、高级对比方

Python自动化处理PDF文档的操作完整指南

《Python自动化处理PDF文档的操作完整指南》在办公自动化中,PDF文档处理是一项常见需求,本文将介绍如何使用Python实现PDF文档的自动化处理,感兴趣的小伙伴可以跟随小编一起学习一下... 目录使用pymupdf读写PDF文件基本概念安装pymupdf提取文本内容提取图像添加水印使用pdfplum

Python从Word文档中提取图片并生成PPT的操作代码

《Python从Word文档中提取图片并生成PPT的操作代码》在日常办公场景中,我们经常需要从Word文档中提取图片,并将这些图片整理到PowerPoint幻灯片中,手动完成这一任务既耗时又容易出错,... 目录引言背景与需求解决方案概述代码解析代码核心逻辑说明总结引言在日常办公场景中,我们经常需要从 W

spring AMQP代码生成rabbitmq的exchange and queue教程

《springAMQP代码生成rabbitmq的exchangeandqueue教程》使用SpringAMQP代码直接创建RabbitMQexchange和queue,并确保绑定关系自动成立,简... 目录spring AMQP代码生成rabbitmq的exchange and 编程queue执行结果总结s

C#高效实现Word文档内容查找与替换的6种方法

《C#高效实现Word文档内容查找与替换的6种方法》在日常文档处理工作中,尤其是面对大型Word文档时,手动查找、替换文本往往既耗时又容易出错,本文整理了C#查找与替换Word内容的6种方法,大家可以... 目录环境准备方法一:查找文本并替换为新文本方法二:使用正则表达式查找并替换文本方法三:将文本替换为图

Python批量替换多个Word文档的多个关键字的方法

《Python批量替换多个Word文档的多个关键字的方法》有时,我们手头上有多个Excel或者Word文件,但是领导突然要求对某几个术语进行批量的修改,你是不是有要崩溃的感觉,所以本文给大家介绍了Py... 目录工具准备先梳理一下思路神奇代码来啦!代码详解激动人心的测试结语嘿,各位小伙伴们,大家好!有没有想

Python调用LibreOffice处理自动化文档的完整指南

《Python调用LibreOffice处理自动化文档的完整指南》在数字化转型的浪潮中,文档处理自动化已成为提升效率的关键,LibreOffice作为开源办公软件的佼佼者,其命令行功能结合Python... 目录引言一、环境搭建:三步构建自动化基石1. 安装LibreOffice与python2. 验证安装

Python操作PDF文档的主流库使用指南

《Python操作PDF文档的主流库使用指南》PDF因其跨平台、格式固定的特性成为文档交换的标准,然而,由于其复杂的内部结构,程序化操作PDF一直是个挑战,本文主要为大家整理了Python操作PD... 目录一、 基础操作1.PyPDF2 (及其继任者 pypdf)2.PyMuPDF / fitz3.Fre