mac下如何使用appledoc生成文档-低调大师

mac下如何使用appledoc生成文档

2018-04-10 521

前言

近期手头项目需要出一下文档，方便使用者查阅。调研了目前比较流行的三款文档生成工具HeaderDoc,Doxygen,appledoc。

Doxygen

Doxygen是C++源码生成文档的标准工具，同时也支持很多其它语言如：C,Objective-C,C#,PHP,Java,Python等等。然而，它生成的文档风格和官方文档的风格差了十万八千里，并且配置复杂。

HeaderDoc

HeaderDoc是苹果官方的文档生成工具。Xcode9以前在安装完Xcode后就可以使用，Xcode9是个重构版本，并没有继承这个。该工具对注释生成规则比较特别，只生成以/*! */ 的格式的注释。生成文档是分散的，并没有一个汇总文件。

appledoc

appledoc只专注Objective-C源代码，并且能生成和苹果官方相同风格的文档。同时支持生成html和直接编译成docset安装进Xcode。代码开源在github上，作者会及时跟开发者沟通。

安装

官方推荐做法是克隆GitHub项目并从Xcode编译该工具。由于克隆GitHub项目将创建与主存储库的链接，它也极大地简化了未来的升级。要进行安装，请在终端中输入以下内容：

git clone git://github.com/tomaz/appledoc.git
cd ./appledoc
sudo sh install-appledoc.sh(如果需要安装模板文件，需添加'-t default')

还可以使用Homebrew进行安装

brew install appledoc

注意：Homebrew默认不会安装模板

安装完成，验证一下是否成功,如果显示版本号则证明安装成功。

appledoc --version

使用

为了演示使用，我创建了测试工程，代码如下

完成了代码的书写，切换到命令行，cd到源码所在的目录，执行以下命令

appledoc -p project_name -v project_version -c company_name --company-id company_id -o ./doc .

如果不想生成docset，可以添加—no-create-docset。想了解更多的话，命令行下可以通过appledoc —help查看。

生成的html：

很像苹果官方文档的风格吧~

部署

生成好的html如何部署到服务器？我的项目是在github,可以通过github pages来实现。简单说就是在github账号下新建一个username.github.io的仓库，然后将生成的doc目录下html目录中的全部内容上传到github该仓库下，然后就可以通过在浏览器中输入 http://username.github.io 来访问生成的文档了

微信关注我们

原文链接：https://yq.aliyun.com/articles/580947

转载内容版权归作者及来源网站所有！

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

Python 学习(十)--数据解析

1. 什么是XML？ XML 指可扩展标记语言（eXtensible Markup Language），标准通用标记语言的子集，是一种用于标记电子文件使其具有结构性的标记语言。 XML 被设计用来传输和存储数据。XML是一套定义语义标记的规则，这些标记将文档分成许多部件并对这些部件加以标识。它也是元标记语言，即定义了用于定义其他与特定领域有关的、语义的、结构化的标记语言的句法语言。 python对XML的解析常见的XML编程接口有DOM和SAX，这两种接口处理XML文件的方式不同，当然使用场合也不同。python有三种方法解析XML，SAX，DOM，以及ElementTree: SAX (simple API for XML ) python 标准库包含SAX解析器，SAX用事件驱动模型，通过在解析XML的过程中触发一个个的事件并调用用户定义的回调函数来处理XML文件。 DOM(Document Object Model) 将XML数据在内存中解析成一个树，通过对树的操作来操作XML。下面用到的movies.xml内容： <collection shelf="New Arri...

2018-04-11

531

版权声明：本文为博主原创文章，转载请标明出处。 https://blog.csdn.net/chaoyu168/article/details/79900485 package zip; import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.OutputStreamWriter; import java.io.Writer; public class ziptest { private static File apktool = null; private static File signapk = null; private static File testkey_pk8 = null; private static File testkey_x509_pem = null; private static File dirFile;// 根目录 public static void main(String args[]) throws IOExc...

2018-04-11

601

资源下载

更多资源

Mario

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长，特征是大鼻子、头戴帽子、身穿背带裤，还留着胡子。与他的双胞胎兄弟路易基一起，长年担任任天堂的招牌角色。

Nacos

Nacos /nɑ:kəʊs/ 是 Dynamic Naming and Configuration Service 的首字母简称，一个易于构建 AI Agent 应用的动态服务发现、配置管理和AI智能体管理平台。Nacos 致力于帮助您发现、配置和管理微服务及AI智能体应用。Nacos 提供了一组简单易用的特性集，帮助您快速实现动态服务发现、服务配置、服务元数据、流量管理。Nacos 帮助您更敏捷和容易地构建、交付和管理微服务平台。

Spring

Spring框架（Spring Framework）是由Rod Johnson于2002年提出的开源Java企业级应用框架，旨在通过使用JavaBean替代传统EJB实现方式降低企业级编程开发的复杂性。该框架基于简单性、可测试性和松耦合性设计理念，提供核心容器、应用上下文、数据访问集成等模块，支持整合Hibernate、Struts等第三方框架，其适用范围不仅限于服务器端开发，绝大多数Java应用均可从中受益。

Rocky Linux

Rocky Linux（中文名：洛基）是由Gregory Kurtzer于2020年12月发起的企业级Linux发行版，作为CentOS稳定版停止维护后与RHEL（Red Hat Enterprise Linux）完全兼容的开源替代方案，由社区拥有并管理，支持x86_64、aarch64等架构。其通过重新编译RHEL源代码提供长期稳定性，采用模块化包装和SELinux安全架构，默认包含GNOME桌面环境及XFS文件系统，支持十年生命周期更新。