appledoc相关内容汇总(非原创)

简介: appledoc appledoc是在stackoverflow上被大家推荐的一个注释工具。有几个原因造成我比较喜欢它: 它默认生成的文档风格和苹果的官方文档是一致的,而doxygen需要另外配置。

appledoc

appledoc是在stackoverflow上被大家推荐的一个注释工具。有几个原因造成我比较喜欢它:

  1. 它默认生成的文档风格和苹果的官方文档是一致的,而doxygen需要另外配置。
  2. appledoc就是用objective-c生成的,必要的时候调试和改动也比较方便。
  3. 可以生成docset,并且集成到xcode中。这一点是很赞的,相当于在源码中按住option再单击就可以调出相应方法的帮助。
  4. appledoc源码在github上,而doxygen在svn上。我个人比较偏激地认为比较活跃的开源项目都应该在github上。
  5. 相对于headerdoc,它没有特殊的注释要求,可以用/** */ 的格式,也可以兼容/*! */的格式的注释,并且生成的注释有汇总页面。

安装

那么简单介绍一下如何安装appledoc,安装非常简单,只需要2步:

1
2
3
 git clone git://github.com/tomaz/appledoc.git
 cd appledoc
 sudo sh install-appledoc.sh

使用

介绍


为了使代码便于阅读,或者所写的代码需要提供给别人使用,这时就需要文档了。而就我们程序员来说,最好的方式莫过于将文档和源码放在一起,在写代码时通过一定的规范编写注释,然后通过工具可以将专门的注释部分抽取出来形成文档,类似的,JAVA语言就自带了javadoc命令。objective-c也中也有相应的工具,经过比较,最终选择了appledoc来做注释工具。appledoc的优点有不少,比如注释风格自由,生成的文档风格与苹果官方文档是一致的,而且可以生成docset,并且集成到xcode中去,也就是说,可以在源码中按住option键单击来调出相应方法的帮助。

appledoc的详细资料,可以参考官方文档。点击这里

安装


appdoc的安装非常简单,依次执行下面代码即可。

git clone git://github.com/tomaz/appledoc.git
cd appledoc
sudo sh install-appledoc.sh

使用


注释格式

我所用的注释格式。注:appledoc的注释内容中,支持基本markdown语法

类和类的成员变量说明:

/**
这里写内容
*/

函数注释:

/**
这里写主要说明(下面空一行之后可以写详细说明)

这里写详细说明

@param 参数1 参数1说明
@param 参数2 参数2说明

@return 返回内容说明
*/

生成文档命令

进入到工程根目录,执行下面命令:

appledoc \                                   
--project-name XXX \
--project-company "XXX" \
--company-id XXX \
--output /tmp/doc \
./Core

其中,XXX 的内容根据具体情况填写,--output 后面接的是文档输出路径,最后一个路径,是需要生成文档的源代码所在路径。

默认情况,在生成docset文档后,appledoc会把生成的html以及中间文件删除,然后将生成的docset文档放置到xcode搜索的文档路径下。若要保存文档生成过程的中间数据比如生成的html文件,只需在上面的命令中增加以下参数即可。

--keep-intermediate-files

以下部分为原创:

如何生成文档,最主要的是配置一个output的路径和input的路径;output路径可以任意指定;input路径是你需要生成appledoc的文件们所在的文件夹路径.

输入命令如上;其中/tmp/doc为output的设置路径,/Core是input路径;在实际操作时可以将路径所在的文件夹拖到终端里,文件夹的路径就会被自动输入到终端里。

生成文档后,在output路径下是一个包含有实际文件路径的txt,通过它你就可以找到所生成的appledoc的全部内容。

未完待续

目录
相关文章
|
7月前
|
存储 人工智能 自然语言处理
智能系统的知识库管理技术
本方案聚焦智能系统的知识库管理,深度融合AI技术与精细化流程控制。通过多模态数据统一存储,实现文本、语音、图像等全格式兼容与智能解析;构建全流程内容管理体系,涵盖创建、审核、更新环节,确保信息精准可靠;提供智能标签分类、版本追溯功能,支持秒级定位与历史对比;采用语义检索技术,打破数据孤岛,助力企业高效利用与优化知识资产,保障安全存储及持续增值。
335 1
|
7月前
|
人工智能 监控 大数据
大数据未来五大趋势,这些变化你真的准备好了吗?
大数据未来五大趋势,这些变化你真的准备好了吗?
488 90
|
11月前
|
并行计算 算法 安全
未来科技:量子计算的崛起与挑战
【10月更文挑战第21天】 本文深入探讨了量子计算这一前沿科技领域的最新进展、核心原理以及面临的主要挑战。通过对比经典计算与量子计算的差异,揭示了量子计算在处理复杂问题时的独特优势。同时,文章还展望了量子计算在未来可能带来的颠覆性变革,并对其发展过程中需要克服的技术难题进行了分析。
343 13
|
7月前
|
人工智能 API 语音技术
HarmonyOS Next~鸿蒙AI功能开发:Core Speech Kit与Core Vision Kit的技术解析与实践
本文深入解析鸿蒙操作系统(HarmonyOS)中的Core Speech Kit与Core Vision Kit,探讨其在AI功能开发中的核心能力与实践方法。Core Speech Kit聚焦语音交互,提供语音识别、合成等功能,支持多场景应用;Core Vision Kit专注视觉处理,涵盖人脸检测、OCR等技术。文章还分析了两者的协同应用及生态发展趋势,展望未来AI技术与鸿蒙系统结合带来的智能交互新阶段。
416 31
|
9月前
|
机器学习/深度学习 人工智能 自然语言处理
《打破知识壁垒:解锁自然语言处理模型跨领域知识图谱关联与推理密码》
在人工智能快速发展的背景下,自然语言处理(NLP)技术成为各行业智能化变革的关键。知识图谱作为结构化的语义知识库,通过“实体-关系-实体”三元组描绘现实世界的概念及其关系,为NLP模型提供背景知识和推理依据。然而,随着多领域知识的爆发式增长,如何实现不同领域知识图谱的有效关联与推理成为亟待解决的问题。本文探讨了理解领域特性、实体对齐、关系映射与融合及深度学习推理模型构建等关键步骤,旨在打破领域间知识壁垒,提升NLP技术的智能化水平,推动其在智能问答、推荐、决策辅助等领域的广泛应用。
305 1
|
开发框架 前端开发 JavaScript
常见的移动应用开发框架有哪些?
跨平台移动开发框架概览:React Native用JavaScript构建UI;Google的Flutter打造原生体验;Ionic结合Angular与Cordova;Xamarin用C#开发iOS和Android;Apple的SwiftUI专注iOS和macOS界面;Android Jetpack提供官方工具集;Kotlin Multiplatform实现多平台共享;NativeScript用JavaScript做原生应用;Cocos2d-x则用于2D游戏开发。选择框架需考虑项目需求、平台、技术栈和团队经验。
694 3
|
人工智能 自然语言处理 Cloud Native
2024云栖大会:大模型驱动的融合通信,哪些场景中潜藏着机遇?
云栖大会 2024,阿里云通信发布多项智能化成果
370 17
|
人工智能 自动驾驶 搜索推荐
AI技术在现代生活中的应用与影响
本文将探讨AI技术在现代生活中的广泛应用,以及它对人们生活方式的影响。我们将从智能家居、自动驾驶汽车、医疗健康、教育等领域出发,分析AI技术如何改变人们的生活。同时,我们也将讨论AI技术可能带来的问题和挑战,以及如何应对这些问题。
|
存储 算法 对象存储
网盘与相册服务PDS体验分享
网盘与相册服务PDS体验分享
294 1