xcode 利用工具快速生成注释

前言 做项目的人多了，就需要文档了。今天开始尝试写一些项目文档。但是就源代码来说，文档最好和源码在一起，这样更新起来更加方便和顺手。象Java语言本身就自带javadoc命令，可以从源码中抽取文档。今天抽空调研了一下objective-c语言的类似工具。 从stackoverflow 上找到三个比较popular的工具：doxygen, headdoc和appledoc 。它们分别的官方网址如

之前一直用我上次发过的代码注释插件，但是系统升级后，就用不了了，重新安装时也会卡住，无法安装，现在找了一个新的插件和大家分享，只需要把git里面的代码clone下来，然后build一下，重启xcode就ok了，git地址：https://github.com/onevcat/VVDocumenter-Xcode

Xcode自动生成的文件注释来导出API文档 Xcode自动生成文件注释文档今天折腾了适用于.h文件的注释：

打开Finder，⇧⌘G 前往 ~/Library/Developer/Xcode/UserData 创建或修改IDETemplateMacros.plist的内容为： <?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> <plist version

在iOS 开发中 注释占有重要地位 为了使代码整洁 干净 给人一种直观的代码意义 注释是必不可少的 那么规范的注释/// 三个///是怎么变成我们规范的注释格式那？ iOS 插件VVDocumenter 帮了我们大忙 下面 是 VVDocumenter的用法

文档化细节 正如你知道的，在Objective-C 和 Swift中写一条注释的最简单办法是用两条斜杠，如下图展示这样： 1 // This is a comment. 你可以（且必须）像上面那样来放置你的注释，以便分清每个部分。但是，当谈到代码注释文档，我肯定不是指的上面的注释。如果整个教程都专注于此肯定

在更新了xcode后，本来用VVDocument插件来进行快速注释的功能不能用。这个是因为苹果解决xcode ghost， 把插件屏蔽了。其实在xcode8中，xcode增加了类似VVDocument的功能，快捷键是Command + Option + /。 不喜欢的朋友打开终端，直接运行: sudo /usr/libexec/xpccachectl ，然后重启电脑后VVDocument生

真心纠结许久:终于解决，谢天谢地 首先下载Xcode插件VVDocumenter-Xcode 该插件支持xcode5、6、7，也支持swift 如何使用VVDocumenter-Xcode 1、将刚下下载下来的VVDocumenter-Xcode工程用xcode打开进行编译，快捷键：command+b 它会自动将插件VVDocumenter-Xcode.xcplu

单行注释：在方法的地方按 Command+/标注的功能，快捷键是Command + Option + / 需要在方法名的上面（空白）的地方按 Command + Option + / 才管用

自从换了Mac后，尴尬的事情来了，我的Mac电脑配置的是普通键盘，发现xcode11无法使用快捷键注释了

一、单行、多行注释 “command + /”，即“⌘ + /”。（如果是 Windows 键盘则为“Win键 + /”） 二、注释文档 把光标定位到需要添加注释文档的对象起始行，或上方的空白行。按下“command + Option + /”，即“⌘ + ⌥ + /”。（如果是 Windows 键盘则为“Win键 + ALT + /”） ...

转自： http://www.cocoachina.com/bbs/read.php?tid=91097 在写代码的时候，如果按照一定的规范在头文件里写上注释的话， 就可以利用Xcode的文档自动输出功能生成一份完整的HTML项目文档。 生成的格式和Apple Developer网站上的API文档几乎是一样的。 我们来看看如何利用Xcode生成项目文档。 步骤: 1. 在XCode

文本为CC原创，如需转载请注明本文地址：http://blog.csdn.net/oktears/article/details/21280347 用Xcode开发遇到一个很麻烦的问题， 就是给函数和类加注释的时候，他不像eclipse那样智能， 开头写上/** 然后敲回车就能自动生成注释，每次都要自己写注释，十分麻烦，自己研究了一小下，发现Xcode也是可以自动添加注释的，只不过需要一个小插件