iOS Build standard annotation tool--vvdocumenter

iOS Build standard annotation tool--vvdocumenter

in the process of development, we have to write a lot of comments, easy to help others also convenient for us to check our code later. However, writing a comment is a waste of our time and energy, to write a document in accordance with the format of the comments, it will consume a lot of our effort, fortunately,Vvdocumenter can help us a lot.

GitHub Address: Https://github.com/onevcat/VVDocumenter-Xcode.

Installation and use: Download the GitHub source code, use Xcode to open the project, run, if successful, the plug-in is installed, at this time, we must have Xcode restarted, before it can be used.

Restart Xcode, enter///In any place, the following annotation template will appear automatically, the parameter part is already written by the placeholder.

/** * < #Description #> * * @param data < #data description#> */-(void) Updatewithdata: (ID) data;

is not write comments become a very interesting thing, you can also make some settings, in the Xcode->window menu bar, there is a vvdocumenter this tab, which can be used to generate comments on the template to make some settings, such as the shortcut key to generate comments, annotation alignment mode, The comment shows the creator and time, and so on. For example, the following settings generate comments like this:

/** * @author Elephant, 15-09-16 13:09:28 * * @brief < #Description #> * * @param data < #data description#> */-(void) Updatewithdata: (ID) data;

Finally, recommend this small plug-in to you, wish you write Code Happy O (∩_∩) O.

iOS Build standard annotation tool--vvdocumenter