Screenshots

Description

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 Wrapper's 'unwrap' functionality to revert a comment to it's original format


RE-WRAPPING COMMENTS:

Once you've 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 Wrapper's '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 that's 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 that's 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 that's 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? Won't wrap your code examples

Ratings and Reviews

logic_error ,

Decent, but doesn't support wider margins than 80

This works great for 40, 60, and 80 character widths, but doesn't do any others. It would be great if it supported 100, 120, etc., and even better would be for it to support arbitary widths.

Drew Olbrich ,

Fantastic

This extension is wonderful and saves me a lot of time.

The only issue I found is that if you line-select a sequence of comment lines by triple-clicking (so that a range of lines are selected, rather than a range of characters), and choose Rewrap, then the line of code that follows the selection will be incorrectly wrapped as part of the comment. Perhaps this issue is caused by the trailing newline character in the selection. It is easy enough to work around this by making a text selection without triple-clicking, of course.

Also, for bonus points, it would be nice if the selection intelligently tracked the rewrapped text, rather than being left unmodified as if it was still defined in terms of the original text.

However, that is all really minor nitpicking. Thank you so much for writing this extension. I've been manually reformatting comment paragraphs since I started using Xcode, and your extension brings unbounded joy and happiness to my day.

Information

Seller
Steven Barnegren
Size
3.7 MB
Category
Developer Tools
Compatibility
macOS 10.13 or later, 64-bit processor
Languages
English
Age Rating
Rated 4+
Copyright
© 2018 Steve Barnegren
Price
Free

Supports

  • Family Sharing

    With Family Sharing set up, up to six family members can use this app.

More By This Developer