用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

相关文章

活用c4d官方开发文档查询代码

当你问AI助手比如豆包,如何用python禁止掉xpresso标签时候,它会提示到 这时候要用到两个东西。https://developers.maxon.net/论坛搜索和开发文档 比如这里我就在官方找到正确的id描述 然后我就把参数标签换过来

计算机毕业设计 大学志愿填报系统 Java+SpringBoot+Vue 前后端分离 文档报告 代码讲解 安装调试

🍊作者:计算机编程-吉哥 🍊简介:专业从事JavaWeb程序开发,微信小程序开发,定制化项目、 源码、代码讲解、文档撰写、ppt制作。做自己喜欢的事,生活就是快乐的。 🍊心愿:点赞 👍 收藏 ⭐评论 📝 🍅 文末获取源码联系 👇🏻 精彩专栏推荐订阅 👇🏻 不然下次找不到哟~Java毕业设计项目~热门选题推荐《1000套》 目录 1.技术选型 2.开发工具 3.功能

Python脚本:TXT文档行数统计

count = 0 #计数变量file_dirs = input('请输入您要统计的文件根路径:')filename = open(file_dirs,'r') #以只读方式打开文件file_contents = filename.read() #读取文档内容到file_contentsfor file_content in file_contents:

bcolz文档

原文:http://bcolz.blosc.org/en/latest/reference.html First level variables bcolz.__version__'''bcolz包的版本。''' bcolz.dask_here'''是否检测到dask的最低版本。''' bcolz.min_dask_version'''需要dask的最低版本(dask是可选

WordPress开发中常用的工具或api文档

http://php.net/ http://httpd.apache.org/ https://wordpress.org/ https://cn.wordpress.org/ https://core.svn.wordpress.org/ zh-cn:开发者文档: https://codex.wordpress.org/zh-cn:%E5%BC%80%E5%8F%91%E8%80%

LLVM入门2:如何基于自己的代码生成IR-LLVM IR code generation实例介绍

概述 本节将通过一个简单的例子来介绍如何生成llvm IR,以Kaleidoscope IR中的例子为例,我们基于LLVM接口构建一个简单的编译器,实现简单的语句解析并转化为LLVM IR,生成对应的LLVM IR部分,代码如下,文件名为toy.cpp,先给出代码,后面会详细介绍每一步分代码: #include "llvm/ADT/APFloat.h"#include "llvm/ADT/S

Python知识点:使用Python进行PDF文档处理

使用 Python 进行 PDF 文档处理可以通过多种库来实现,包括 PyPDF2、pdfplumber、reportlab、pdfminer 等。这些库可以处理不同的 PDF 任务,例如 提取文本、拆分合并 PDF、修改 PDF、生成 PDF 等。以下是几种常见操作及对应的库和代码示例。 1. 安装常用库 首先,安装常用的 PDF 处理库: pip install PyPDF2 pdfpl

【2025】基于Python的空气质量综合分析系统的设计与实现(源码+文档+调试+答疑)

博主介绍:     ✌我是阿龙,一名专注于Java技术领域的程序员,全网拥有10W+粉丝。作为CSDN特邀作者、博客专家、新星计划导师,我在计算机毕业设计开发方面积累了丰富的经验。同时,我也是掘金、华为云、阿里云、InfoQ等平台的优质作者。通过长期分享和实战指导,我致力于帮助更多学生完成毕业项目和技术提升。 技术范围:     我熟悉的技术领域涵盖SpringBoot、Vue、SSM、HLMT

自动化表格处理的革命:智能文档系统技术解析

在当今数据驱动的商业环境中,表格数据的自动化处理成为了企业提高效率、降低成本的关键。企业智能文档系统在智能表格识别方面展现出卓越的性能,通过精准识别和处理各种通用表格,显著提升了企业文档管理的智能化水平。本文将深入探讨该系统在表格识别方面的关键技术和应用优势,以及如何通过行业定制化服务满足不同行业的需求。 1. 通用表格识别 智能文档系统通过先进的OCR技术和表格结构识别算法,能够精准

在 Qt Creator 中,输入 /** 并按下Enter可以自动生成 Doxygen 风格的注释

在 Qt Creator 中,当你输入 /** 时,确实会自动补全标准的 Doxygen 风格注释。这是因为 Qt Creator 支持 Doxygen 以及类似的文档注释风格,并且提供了代码自动补全功能。 以下是如何在 Qt Creator 中使用和显示这些注释标记的步骤: 1. 自动补全 Doxygen 风格注释 在 Qt Creator 中,你可以这样操作: 在你的代码中,将光标放在