`
zhy584520
  • 浏览: 183901 次
  • 性别: Icon_minigender_1
  • 来自: 广州
社区版块
存档分类
最新评论

Objective-C代码注释和文档输出的工具和方法

    博客分类:
  • IOS
 
阅读更多

代码注释可以让代码更容易接受和使用,特别是在大型项目合作开发或模块开发中。Objective-C中也有一些很方便的注释插件和文档生成工具。本文推荐两个开源软件:VVDocumenter注释工具和appledoc文档生成工具。

VVDocumenter

首先推荐一个Xcode插件VVDocumenter,它可以让我们在代码中快捷的插入通用的注释代码。

image

有了这个插件只需要在要注释的方法定义前输入三个斜杠(///),它就会自动为我们生成注释模板,这些注释模板可以用文档输出工具输出为说明文档。

下载和安装VVDocumenter

VVDocumenter插件是github上的一个开源项目,地址是https://github.com/onevcat/VVDocumenter-Xcode。你可以git clone或在github网站上下载工程的zip压缩文件。下载完成后,打开其中的工程,build&run一下就安装成功了。然后记得要重新启动一下Xcode应用,VVDocumenter插件就生效了。试试在方法定义前输入“///”。

appledoc

我们开发自己的模块时,经常会将模块接口提供给别人使用,这样我们不得不写一些接口说明文档。很多语言都提供了这种工具比如javadoc,doxygen等,可以将注释代码转化成在线文档。这里推荐一个特别适合Objective-C语言的一种文档输出工具appledoc。它可以把一些格式的注释转换成Apple SDK风格的文档,同时它支持VVDocumenter的输出注释格式。

安装appledoc

建议使用brew命令来安装,如果没有安装brew,可以先用一下命令安装一下:

ruby -e "$(curl -fsSL https://raw.github.com/mxcl/homebrew/go)":

然后执行brew安装命令来安装appledoc

brew install appledoc

使用appledoc生成文档

appledoc [OPTIONS] <paths to source dirs or files>

该命令将生成并安装文档到Xcode,可以通过Xcode的文档浏览器来查看文档,并可以在Xcode中搜索到相关接口。

image

分享到:
评论

相关推荐

    Objective-C程序设计.doc

    这个简单的程序展示了Objective-C的基本结构和注释方式,以及如何使用`NSLog`进行输出。 Objective-C在苹果的iOS和Mac OS X平台上广泛使用,尤其在开发原生应用程序时是首选语言。通过Xcode提供的工具链,开发者...

    swift-jazzyOC和Swift文档生成工具

    本文将深入探讨"swift-jazzy"和"OC"(Objective-C)在文档生成工具方面的应用。 Swift-Jazzy是一个专门为Swift编写的文档生成工具,它能够帮助开发者从源代码中的注释中提取出详细的信息,生成类似Javadoc风格的高...

    Doxygen代码注释规范

    "Doxygen代码注释规范" Doxygen是一种开源跨平台的,以类似JavaDoc风格描述的文档系统,完全支持C、C++、Java、Objective-C和IDL语言,部分支持PHP、C#。Doxygen可以从一套归档源文件开始,生成HTML格式的在线类...

    Doxygen代码注释标准.7z

    这个压缩包“Doxygen代码注释标准.7z”包含了最新版本的Doxygen安装程序、Graphviz图形生成工具以及帮助文档生成所需的相关软件,旨在帮助开发者遵循Doxygen注释规范,生成清晰、详尽的项目文档。 首先,让我们深入...

    Xcode入门引导

    Objective-C 支持单行注释(使用 `//`)和多行注释(使用 `/* */`)。良好的注释习惯有助于他人理解代码逻辑,也是团队协作的基础之一。 ##### 2.3 函数 函数是代码的基本组织单元,它将相关的操作封装在一起,以...

    appledoc自动文档生成工具

    1. **自动生成文档**:`appledoc`能解析Objective-C源代码中的注释,将这些注释转化为结构化的API文档,包括类、方法、属性等各个层面的详细说明。 2. **遵循Apple风格**:生成的文档格式与Apple的官方文档一致,...

    爵士乐:Swift和Objective-C的忠实文档

    jazzy是一个命令行实用程序,可为Swift或Objective-C生成文档 关于 Swift和Objective-C项目均受支持。 与解析源文件不同, jazzy钩接到和以使用代码的表示及其注释来获得更准确的结果。 输出与WWDC 2014之后的苹果...

    internal_lex:在objective-c中运行的简单词法分析

    在Objective-C编程语言中,词法分析(lexical analysis)是编译器设计的重要部分,它负责将源代码转换成一系列有意义的符号,为后续的语法分析和编译过程打下基础。`internal_lex`项目是一个专门针对Objective-C的...

    Doxygen代码注释规范.docx

    Doxygen 代码注释规范 Doxygen 是一种开源跨平台的,以类似 JavaDoc 风格描述的文档系统,完全支持 C、C++、Java、Objective-C 和 IDL 语言,部分支持 PHP、C#。Doxygen 可以从一套归档源文件开始,生成 HTML 格式...

    doxygen代码文档生成工具

    总的来说,Doxygen是开发者不可或缺的辅助工具,它将源代码的注释转化为高质量的文档,极大地提高了团队合作的效率和代码的可理解性。通过熟练掌握Doxygen的使用,开发者可以更好地管理和维护项目,同时提升项目的...

    代码注释规范之doxygen

    总之,Doxygen提供了一套完整的程序注释文档化解决方案,它能够自动识别遵循特定注释规范的代码段,并生成多种格式的文档。为了充分发挥Doxygen的作用,开发者需要了解其配置方法以及如何利用Graphviz和...

    代码文档工具Doxygen快速入门V1.00_20120704(ZLG模板)

    通过上述介绍,我们可以了解到Doxygen不仅是一款优秀的代码文档生成工具,还能帮助开发者更好地管理和维护项目文档。无论是个人项目还是团队协作,Doxygen都是一个非常有价值的工具。通过合理地利用其特性,可以极大...

    ZSSRichTextEditor.zip

    这个编辑器不仅美观,而且功能强大,特别值得一提的是它具备源代码语法高亮的功能,对于需要处理复杂文本格式和编程代码的开发者来说,无疑是一个极具价值的工具。 首先,我们要理解Objective-C,这是苹果公司开发...

    doxygen 注释生成工具

    这款工具支持多种编程语言,包括C++, C, Java, Python, Objective-C, PHP, C#, Fortran等,使得开发者无需编写大量重复的文档,只需在代码中添加特定的注释,就能自动生成高质量的文档。 **关键字和语法** `...

    使用Doxygen生成文档

    通过这些方法,开发者可以有效地利用Doxygen工具,将代码中的注释转换为高质量的文档,提高代码的可读性和维护性。对于使用Qt环境的开发者来说,结合QTCreator的Doxygen插件能更便捷地管理和生成项目文档,是提高...

    Xcode4快速Doxygen文档注释

    【Xcode4快速Doxygen文档注释】 ...总之,Xcode4与Doxygen的结合使得在Objective-C项目中创建文档变得更加便捷,这对于任何开发团队来说都是一个非常有价值的工具,特别是对于那些重视代码质量和团队协作的项目。

    Doxygen 文档生成工具

    这个工具支持多种编程语言,包括但不限于C++, C, Java, Objective-C, Python, Fortran, VHDL等,真正实现了跨语言的文档生成能力。 Doxygen的工作原理主要基于代码中的注释。它识别特定格式的注释块,如C++的`///`...

    C/C++文档生成软件

    标题 "C/C++文档生成软件" 提到的是用于创建C/C++代码文档的工具,而描述 "可以很好的管理你的程序文件以及版本资料" 暗示了该软件能帮助开发者组织和跟踪代码的变化。标签 "doxygen 软件" 明确指出这个工具是...

    doxygen全套工具——包括说明文档

    它的主要功能是解析源代码,提取出函数、类、变量等元素的信息,并结合代码注释生成高质量的文档,这些文档通常以HTML、PDF、CHM等多种格式呈现。 1. **注释规范**:Doxygen支持特定的注释格式,如C++的`/** ... */...

Global site tag (gtag.js) - Google Analytics