Xcode注释利器



在开发过程中,离不开的就是注释,一个好的注释格式,可以帮助我们在代码结束后,生成HTML或CMH等其他格式的文档,当然也可以直接在项目中使用Option+左键的形式点击方法名称,出现方法简介和各个参数的描述。

例如:

alt text

alt text



要实现上述的格式,有一个最简单方法,就是使用VVDocumenter-Xcode,这个是在GitHub上开源的一个项目,点击可以下载。

使用方法很简单,下载后打开工程,使用command+b编译一次工程,然后重启Xcode,这样在任何一个Xcode工程中,使用///就可以出现很标准的注释格式了。

编译完成后删除掉VVDocumenter-Xcode也可以。



对于GitHub不熟悉的同学,可以使用终端下载


1.打开终端,输入cd Desktop

2.输入git clone https://github.com/onevcat/VVDocumenter-Xcode.git

*