iOS headerdoc 代码注释打包sdk

最新推荐文章于 2021-06-29 07:40:10 发布
最新推荐文章于 2021-06-29 07:40:10 发布
阅读量611 收藏
点赞数
分类专栏： iOS技术汇总 文章标签： headerdoc ios
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/sinat_34245894/article/details/78278323
版权

有时候我们需要封装sdk给其他人使用，现在我们可以这样做

把你的注释包含在 /*! – */块里

打开终端

先cd 你要打包注释的项目

cd /Users/yxy/Desktop/KM34Project 

输入 headerdoc2html -o OutputDirectory InputDirectory

OutputDirectory是要输出的那个文件路径，我们在桌面上建立一个这个文件夹DocDemo

InputDirectory是你的项目文件夹就是这个文件KM34Project

比如最终结果 headerdoc2html -o /Users/yxy/Desktop/DocDemo KM34Project/

我们就可以在桌面上的DocDemo这个文件中找到html文件

最后要合并所有的html

在终端输入 gatherheaderdoc /Users/yxy/Desktop/DocDemo

然后在浏览器中打开masterTOC.html文件就是最终我们想要的

絮语时光
关注
专栏目录
iOS ipad 开发例子： （美团的界面，大众点评的API）
iOS逆向与安全
07-01 1万+
前言1、从DKMeituanHD项目中体会了真正的MVC思想 2、总结了谓词技术的使用例子http://developer.dianping.com/app/tech/api https://developer.apple.com/search/?q=headerdoc%20user%20guide%20xcode&type=Guides正文1、DKCategoryViewController
iOS开发日记23-Xcode生成API文档(HeaderDoc)
weixin_30344131的博客
09-22 136
今天博主有一个Xcode生成API文档的需求,遇到了一些困难点,在此和大家分享,希望能够共同进步. 今天公司和客户交接源码,但是客户提出不仅需要源码,还需要相应的技术文档,今天博主就和大家分享一下,如何使用Xcode生成你的技术文档. 生成技术文档主要有三个工具: headerdoc,doxygen 和 appledoc.其中headerdoc是苹果官方的生成工具,后两个是第三方工具.如果X...
Xcode HeaderDoc 教程（1）
kmyhy的专栏
08-05 5203
原文： http://www.raywenderlich.com/66395/documenting-in-xcode-with-headerdoc-tutorial学习如何从代码中生成文档！Xcode 5 和 iOS7 发布时，大多数人可能没有注意到 HeaderDoc。HeaderDoc 是一个命令行工具，允许你从代码中自动生成格式良好的HTML 文档——当然，注释必须是用指定的格式提供的。另
iOS SDK封装
wanmeizty的专栏
05-09 2889
一.framework封装 1、新建iOS->Framework & Library->Cocoa Touch Framework 2、在PROJECT->Deployment Target->iOS Deployment Target选择你需要支持的最低系统。 同样的操作在TARGETS中，Deployment Info->Deployment ...
headerdoc
iamfafa的专栏
05-08 986
http://kevin-wu.net/how-to-create-documentation-with-xcode/ shell脚本 # shell script goes here mkdir -p headerDoc find ./HelloPhoneGap/Classes -name \*.h -print | xargs headerdoc2html -o hea
Xcode HeaderDoc 教程（3）
kmyhy的专栏
08-05 6534
打开 MathAPI.h，将第一个 @param 标签的参数名由firstNumber 修改为 thirdNumber,然后编译。有一个警告发生，甚至提出了修改建议。它不会影响任何事情，但有助于检查文档中的错误。特殊注释Xcode 还支持几种特殊注释，对于你或者使用你代码的人非常有用。打开 Car.m，在 driveCarWithCompletion: 方法中，在调用completion 块之前添
注释使用的工具和文件
07-15
XCode作为Apple官方推荐的iOS和macOS应用开发环境，提供了多种方式来方便地添加和管理代码注释。本篇文章将详细介绍在XCode中如何使用工具进行高效注释。 首先，XCode本身内置了基本的注释功能，支持单行注释（`//`...
xcode为方法添加注释工具
09-18
Xcode作为苹果官方推荐的iOS和macOS应用开发环境，提供了丰富的功能来帮助开发者高效地为代码添加注释。本文将详细讲解如何在Xcode中为方法添加注释，以及它所带来的好处。 首先，我们了解Xcode中添加注释的基本...
建立iOS专属文档之Objective-C API文档生成器
joshDalar0的博客
10-24 454
安装 git clone git://github.com/tomaz/appledoc.git cd appledoc sudo sh install-appledoc.sh 使用brew安装 brew install appledoc 验证 appledoc --version 我安装的版本: appledoc version: 2.2.1 (build 1334) 使用 方式一： CD进入项...
xcode 自动添加注释，生成文档
我爱大馅饼
07-09 768
一、自动生成注释代码        添加一个快捷键，生成 注释代码        ThisService 下载连接：http://wafflesoftware.net/thisservice/          Doxygen.rb 下载连接：http://www.brokenrul.es/blog/wp-content/uploads/2011/03/Doxygen.rb_.zip
Xcode HeaderDoc 教程（2）
kmyhy的专栏
08-05 2881
Code Snippets，让一切变得更简单:这真的很容易，不是吗？但还能更简单一些吗？本站曾经介绍过 code snippets，请看这里。Code snippets 在 Xcode 中扮演着无名英雄的角色。一个snippet 是一个可以重用的代码块（存储在 snippet 库中）。Snippets 甚至可以包含一些需要你去填充的占位符。这意味着什么？你可以用 snipppet来为你进行文档化。
headerdoc2html 快速插入注释,[技巧]使用Xcode集成的HeaderDoc自动生成注释和开发文档...
weixin_33959449的博客
06-29 186
Doxygen本来是一个很好的工具，可是我感觉在mac系统下，如果用doxygen最后生成的CHM文件感觉就不是那么恰当，应为本身CHM是微软的产品，苹果系统上并不是很通用，很经常出现文件乱码的情况。这时CHM就比不过PDF和RTF文件。其实直接的html文件也不错。那在mac平台下没有什么其他的替代方法吗，肯定是有的。特地留意了一下，发现以前真是没有好好的使用xcode强大功能。HeaderDo...
注释生成文档工具——appledoc 与xcode自带的官方headerDoc比较后，选appledoc。
zzx240394381的博客
01-16 780
一开始尝试了官方的文档工具headerDoc，发现竟然不能直接 option+commad+／注释生成想要的文档内容，它的格式比较奇葩，需要将 /** 修改为 /*!  ； 而且必须在 每个 .h文件的 @interface前面，为每个类 多加一个 /*!  @class 类名 @abstract 详情          */ 否则，你在html网页上你看不到那个类名，也就找不
headerdoc2html 快速插入注释,如何将iOS headerdoc 代码注释打包封装sdk以便他人使用...
weixin_32204175的博客
06-29 182
如何将iOS headerdoc 代码注释打包封装sdk以便他人使用，有时候我们需要封装sdk给其他人使用，现在我们可以这样做。把你的注释包含在 /*! – */块里打开终端先cd 你要打包注释的项目cd /Users/yxy/Desktop/KM34Project输入headerdoc2html-oOutputDirectoryInputDirectoryOutputDirectory是要输出的...
利用HeaderDoc自动生成API文档
weixin_33749242的博客
03-29 491
2019独角兽企业重金招聘Python工程师标准>>> ...
How to user headerdoc2html
无限互联@彪哥
12-05 161
http://developer.apple.com/opensource/tools/headerdoc.html http://www.cocoachina.com/blog/blog.php?do=showone&uid=9501&type=blog&itemid=2622 http://developer.apple.com/library/mac/#documenta...
使用Xcode HeaderDoc和Doxygen文档化你的Objective-C和Swift代码
weixin_30707875的博客
06-30 128
在一个应用的整个开发过程中涉及到了无数的步骤。其中一些是应用的说明，图片的创作，应用的实现，和实现过后的测试阶段。写代码可能组成了这个过程的绝大部分，因为正是它给了应用生命，但是这样还不够，与它同等重要的还有代码的注释和文档编写。不管代码写的有多好，如果缺少了对应的好的注释文档，很有可能在将来带来麻烦。不幸的是，许多开发者都忽视或忽略了代码文档的重要性，而这非常糟糕，因为好的程序不仅仅是好的代码。...
[技巧]使用Xcode集成的HeaderDoc自动生成注释和开发文档
weixin_34032792的博客
11-07 142
Doxygen本来是一个很好的工具，可是我感觉在mac系统下，如果用doxygen最后生成的CHM文件感觉就不是那么恰当，应为本身CHM是微软的产品，苹果系统上并不是很通用，很经常出现文件乱码的情况。这时CHM就比不过PDF和RTF文件。其实直接的html文件也不错。 那在mac平台下没有什么其他的替代方法吗，肯定是有的。特地留意了一下，发现以前真是没有好好的使用xcode...
【推荐】apidoc api文档生成工具的使用(mac)
my blog
05-29 6349
apidoc是通过js和json文件生成本地的html api文档，个人感觉相当好用；github地址：https://github.com/apidoc/apidoc1.安装 apidoc，如果不行安装一下nodejs npm install apidoc -g或者使用sudo npm install apidoc -g2.cd 到当前目录，然后执行以下命令，会在本目录中创建api-docs的文...
文件下载header设置
小何的博客
10-27 4270
我们在做功能开发时，会涉及到文件下载的功能。但该功能并不常用，容易忘记。因此作此记录 设置下载的文件名 response.setHeader("Content-Disposition","attachment;filename*=utf-8'zh_cn'文件名"); 由于用以上语句设置文件名会导致中文乱码，因此需要对中文的部分进行编码： response....
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值