Comment Wrapper is an Xcode source editor extension that can format comments to wrap at a certain line length.
WRAPPING COMMENTS:
You might have a comment that looks like this:
/// This is a long comment that descripes some behavior. Long comments are difficult to read because they become very long horizontally. We often place limits on how many columns wide our code should be in order to improve readablity, but this can be more difficult to achieve with comments
Using Comment Wrapper to wrap the text at a line length of 80 results in the following:
/// This is a long comment that descripes some behavior. Long comments are difficult
/// to read because they become very long horizontally. We often place limits on how
/// many columns wide our code should be in order to improve readablity, but this
/// can be more difficult to achieve with comments
UNWRAPPING COMMENTS:
Want to edit a wrapped comment? No problem, use the Comment Wrappers unwrap functionality to revert a comment to its original format
RE-WRAPPING COMMENTS:
Once youve wrapped a comment, you might want to edit it in place, although adding or removing characters an a particular line will make it too long or too short. You can use Comment Wrappers re-wrap functionality to re-wrap the comment.
Original comment (wrapped at a line length of 60:
// This code performs actions 1, 2 and 3 on any input a, b or
// c. Any action thats passed in must conform to firstProtocol
// and secondProtocol. The result will be of a type x, y or z.
After editing:
// This code performs actions 1, 2 and 3 on any input a, b or
// c. Any action thats passed in must not confrom to XYZProtocol but must conform to firstProtocol
// and secondProtocol. The result will be of a type x, y or z.
After Re-wrapping:
// This code performs actions 1, 2 and 3 on any input a, b or
// c. Any action thats passed in must not confrom to
// XYZProtocol but must conform to firstProtocol and
// secondProtocol. The result will be of a type x, y or z.
FEATURES:
- Maintains your leading comment prefix (eg. `//`, `///`)
- Maintains indenting
- Wraps at line lengths of 40, 60 or 80
- Re-wraps edited comments
- Wrapping documentation? Wont wrap your code examples
