做项目一般都会要求写技术文档,特别是提供SDK或者基础组件的.如果手写这类技术文档的话,工作量比编写代码也少不了多少.比如 Java 语言本身就自带 javadoc 命令,可以从源码中抽取文档.本篇我们看一下OC中的一个类似工具:appledoc. 1.简介 基于命令行的操作.使用方便,默认生成的文档风格和苹果的官方文档是一致的,即docset,集成到xcode中就跟苹果的官方文档一模一样,在源码中按住option再单击就可以调出相应方法的帮助,当然也可以生成html文档. 总结一下,它具有下面…

从源码中抽取注释生成文档的专用工具: [doxygen](http://www.stack.nl/~dimitri/doxygen/index.html):适于生成html文档与pdf文档. 支持的语言多,可以配置的地方也比较多.默认生成的风格与苹果的风格不一致. [headdoc](http://developer.apple.com/opensource/tools/headerdoc.html) :是 Xcode 自带的文档生成工具.在安装完 Xcode 后,就可以用命令行来生成对应的文档…

前言 本文的文字及图片来源于网络,仅供学习.交流使用,不具有任何商业用途,版权归原作者所有,如有问题请及时联系我们以作处理. 最近在写技术文档的时候,发现一个问题.对于每个技术步骤,都需要一个截图,这样下来整篇文档都是截图,显得不是特别的专业. 我们要在pycharm中安装一个python包,就可以按照以下的步骤去做. 环境配置 python版本:3.6.0 编辑器:pycharm 项目所需要的环境安装包 第一步:导包 imageio:这个第三方库可以导入很多格式类型的照片,然后又可以将其导出成…

文档导读 https://developer.apple.com/legacy/library/navigation/ 前面我们讲Xcode的文档结构是在介绍如何能够快速定位到你要找的内容.但是很多人的问题可能是一开始就根本不知道要读什么. 这里我们就介绍自学iOS开发应该遵循或者说我们推荐的必读文档的阅读顺序. 阅读顺序: <马上着手开发 iOS 应用程序 (Start Developing iOS Apps Today)> <Your First iOS App> <Yo…

一直想写这么一个东西,长期以来我发现很多初学者的问题在于不掌握学习的方法,所以,Xcode那么好的SDK文档摆在那里,对他们也起不到什么太大的作用.从论坛.微博等等地方看到的初学者提出的问题,也暴露出他们不知道很多他们的疑惑其实在文档里面写的非常清楚.而有时候当他们想从文档去找解决方案的时候,也往往找不到.或者有些人意识到了,阅读文档是学习的好办法,但是不得要领. 中国的技术社区有一个很没意思的毛病,就是技术深了,看不懂骂不知所云,技术浅了,看得懂骂没有技术含量.不过管那么孙子做啥,对于现在可能…

Kafka 技术文档   目录 1 Kafka创建背景 2 Kafka简介 3 Kafka好处 3.1 解耦 3.2 冗余 3.3 扩展性 3.4 灵活性 & 峰值处理能力 3.5 可恢复性 3.6 顺序保证 3.7 缓冲 3.8 异步通信 4 Kafka架构 4.1 producer 4.1.1 定义 4.1.2 负载均衡和HA(High Available)机制 4.1.3 Producer均衡算法 4.1.4 异步发送 4.2 Broker 4.3 Topic和Partition 4.3.…

RabbitMq 技术文档 目录 1 AMQP简介 2 AMQP的实现 3 RabbitMQ简介 3.1 概念说明 3.2 消息队列的使用过程 3.3 RabbitMQ的特性 4 RabbitMQ使用向导 5 官网提供的几种工作方式(教程) 5.1 Hello World 5.2 工作队列 5.3 发布/订阅 5.4 路由选择 (Routing) 5.5 主题(Topic) 5.6 RPC 6 消息的可靠传递 6.1 连接失败的处理 6.2 服务器的可靠性 6.3 生产者的可靠性 6.4 消费者…

unity3d 脚本参考-技术文档 核心提示:一.脚本概览这是一个关于Unity内部脚本如何工作的简单概览.Unity内部的脚本,是通过附加自定义脚本对象到游戏物体组成的.在脚本对象内部不同志的函数被特定的事件调用.最常用的列在下面:Update:这个函数在渲染一帧之前被调用,这里是大部分游戏行为代码被执行的地方,除了物理代码.FixedUpd 一. 脚本概览这是一个关于Unity内部脚本如何工作的简单概览.Unity内部的脚本,是通过附加自定义脚本对象到游戏物体组成的.在脚本对象内部不同志的函…

关于调试,查看Xcode Overview文档相关部分:http://developer.apple.com/library/ios/documentation/ToolsLanguages/Conceptual/Xcode_Overview/DebugYourApp.html…

1.jupyter Notebook的组成 这里它的组件及其工程构成,帮助大家更好的用好jupyter Notebook 组件 Jupyter Notebook结合了三个组件: 笔记本Web应用程序:交互式Web应用程序,用于交互编写和运行代码以及编写笔记本文档. 内核:笔记本Web应用程序启动的独立进程,它以给定语言运行用户代码,并将输出返回给笔记本Web应用程序.内核还处理诸如交互式小部件,选项卡完成和内省的计算. 笔记本文档:自包含文档,其中包含笔记本Web应用程序中可见的所有内容的表示,…