# VVDocumenter-Xcode [![Build Status](https://api.travis-ci.org/onevcat/VVDocumenter-Xcode.svg)](https://travis-ci.org/onevcat/VVDocumenter-Xcode) <a href="https://flattr.com/submit/auto?user_id=onevcat&url=https%3A%2F%2Fgithub.com%2Fonevcat%2FVVDocumenter-Xcode" target="_blank"><img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
---
## What is this?
Writing document is so important for developing, but it is really painful with Xcode. Think about how much time you are wasting in pressing '*' or '/', and typing the parameters again and again. Now, you can find the method (or any code) you want to document to, and type in `///`, the document will be generated for you and all params and return will be extracted into a Javadoc style, which is compatible with [appledoc](https://github.com/tomaz/appledoc), [Doxygen](http://www.stack.nl/~dimitri/doxygen/) and [HeaderDoc](https://developer.apple.com/library/mac/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html). You can just fill the inline placeholder tokens to finish your document.
Here is an image which can show what it exactly does.
![Screenshot](https://raw.github.com/onevcat/VVDocumenter-Xcode/master/ScreenShot.gif)
## How to use it?
Build the `VVDocumenter-Xcode` target in the Xcode project and the plug-in will automatically be installed in `~/Library/Application Support/Developer/Shared/Xcode/Plug-ins`. Relaunch Xcode and type in `///` above any code you want to write a document to.
If you want to use other text beside of `///` to trigger the document insertion, you can find a setting panel by clicking `VVDocument` in the Window menu of Xcode. You can also find some other useful options there, including setting using spaces instead of tab in the panel or changing the format of generated documentation.
## Xcode version?
This plug-in is developed and tested in Mac OSX 10.8.5 Xcode 5. **The master branch dropped support for Xcode 4. If you want to use it in Xcode 4, please check out the [Xcode4 branch](https://github.com/onevcat/VVDocumenter-Xcode/tree/Xcode4).** In Xcode 5, Apple added an UUID-verification to all plugins to ensure the stability when Xcode gets updated. The value of DVTPlugInCompatibilityUUIDs in project plist should contains current UUID of Xcode version, or the plugin does not work. I have added a pre-actions script in scheme to set it for you. **Once you update your Xcode, the plugin would be invalid and you should check the newest version and built it again.**
The default deployment target is 10.8. If you want to use it in a earlier OS version, you should change OS X Deployment Target (in project info setting) to your system version.
## Limitations
The plugin is using simulation of keyboard event to insert the doc comments for you. So it is depending the keyboard shortcut of Xcode. These two kinds of operation are being used:
* Delete to Beginning of the Line (⌘⌫)
* Paste (⌘V)
If you have modified these two shortcuts in your Xcode, the newset version of the plugin would not work correctly. Instead, you can use a earlier version such as [this one(commit 03c4169ff7)](https://github.com/onevcat/VVDocumenter-Xcode/tree/03c4169ff79b618b9fd3db93dd96652a522ad3e0). Be causion you may suffer an [undo and redo issue ](https://github.com/onevcat/VVDocumenter-Xcode/issues/3).
And there are a set of code type I hope to support, but now I just finished some of them.
* ~~Objc Method (Done)~~
* ~~C Function (Done)~~
* ~~Macro (Done)~~
* ~~Property (Done)~~
* ~~Variable (Done)~~
* ~~NS_Enum (Done)~~
* ~~NS_OPTIONS (Done)~~
* Struct (To do)
* Union (To do)
Now the docs for to-do types will be generated only with a basic description (which is the same as Property and Variable).
## Contributors
Thanks for all contributors of this project.
[@idpaterson](https://github.com/idpaterson) [@nickskull](https://github.com/nickskull) [@Ahti](https://github.com/Ahti) [@ilg](https://github.com/ilg) [@zxhfirefox](https://github.com/zxhfirefox) [@xlchen](https://github.com/xlchen)
## License
VVDocumenter is published under MIT License
Copyright (c) 2013 Wei Wang (@onevcat)
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the
Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
没有合适的资源?快使用搜索试试~ 我知道了~
VVDocumenter-Xcode-注释插件
共63个文件
m:21个
h:21个
plist:4个
5星 · 超过95%的资源 需积分: 15 243 下载量 87 浏览量
2014-05-27
08:51:22
上传
评论
收藏 559KB ZIP 举报
温馨提示
Xcode的插件,用于iOS开发,便于编写注释。在输入“///”的时候,会根据函数自动生成多参数匹配的多行注释。
资源推荐
资源详情
资源评论
收起资源包目录
VVDocumenter-Xcode-注释插件.zip (63个子文件)
VVDocumenter-Xcode-注释插件
.travis.yml 99B
read.txt 318B
VVDocumenterTests
VVDocumenterTests.m 2KB
VVDocumenterTests-Info.plist 691B
VVDocumenterTests-Prefix.pch 319B
VVTestHelper.h 414B
DocumenterTests
VVMethodTestsCode.plist 11KB
en.lproj
InfoPlist.strings 45B
SyntaxTests
SyntaxTests.m 5KB
SyntaxTests.h 214B
VVTestHelper.m 6KB
CommenterTests
CommenterTests.h 220B
CommenterTests.m 3KB
VVDocumenter-Xcode
VVDocumenter.m 3KB
VVDocumenter-Xcode-Info.plist 1KB
Commenter
VVMacroCommenter.m 638B
VVFunctionCommenter.m 1KB
VVMacroCommenter.h 231B
VVVariableCommenter.m 228B
VVBaseCommenter.m 5KB
VVArgument.h 296B
VVEnumCommenter.h 229B
VVPropertyCommenter.m 228B
VVPropertyCommenter.h 237B
VVStructCommenter.m 222B
VVMethodCommenter.h 233B
VVFunctionCommenter.h 237B
VVStructCommenter.h 233B
VVCommenter.h 477B
VVVariableCommenter.h 237B
VVEnumCommenter.m 3KB
VVArgument.m 2KB
VVBaseCommenter.h 743B
VVMethodCommenter.m 1KB
VVDocumenterManager.m 9KB
VVDocumenter.h 313B
en.lproj
InfoPlist.strings 45B
VVDocumenterManager.h 236B
VVDocumenter-Xcode-Prefix.pch 323B
Setting
VVDSettingPanelWindowController.m 7KB
VVDocumenterSetting.m 5KB
VVDSettingPanelWindowController.xib 57KB
VVDSettingPanelWindowController.h 259B
VVDocumenterSetting.h 715B
KeyboardHelper
VVKeyboardEventSender.h 726B
VVKeyboardEventSender.m 2KB
OCCategory
NSString+PDRegex
NSString+PDRegex.m 4KB
NSString+PDRegex.h 1KB
NSString+VVSyntax
NSString+VVSyntax.m 1KB
NSString+VVSyntax.h 482B
NSTextView+VVTextGetter
NSTextView+VVTextGetter.m 5KB
NSTextView+VVTextGetter.h 592B
VVDocumenter-Xcode.xcodeproj
project.xcworkspace
contents.xcworkspacedata 163B
xcuserdata
zhangshaoyu.xcuserdatad
UserInterfaceState.xcuserstate 7KB
onevcat.xcuserdatad
WorkspaceSettings.xcsettings 333B
project.pbxproj 38KB
xcuserdata
zhangshaoyu.xcuserdatad
xcschemes
xcschememanagement.plist 427B
xcshareddata
xcschemes
VVDocumenter-Xcode.xcscheme 2KB
VVDocumenterTests.xcscheme 2KB
.DS_Store 6KB
ScreenShot.gif 454KB
.gitignore 4KB
README.md 5KB
共 63 条
- 1
番薯大佬
- 粉丝: 370
- 资源: 53
上传资源 快速赚钱
- 我的内容管理 展开
- 我的资源 快来上传第一个资源
- 我的收益 登录查看自己的收益
- 我的积分 登录查看自己的积分
- 我的C币 登录后查看C币余额
- 我的收藏
- 我的下载
- 下载帮助
安全验证
文档复制为VIP权益,开通VIP直接复制
信息提交成功
- 1
- 2
前往页