Comment Wrapper for Xcode 4+

Name: Comment Wrapper for Xcode
Rating: 3.1 (7 reviews)
Author: Steven Barnegren

Steven Barnegren

- 3.1 • 7 个评分

- 免费

截屏

简介

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

2021年5月6日

版本 1.1

- Correctly identifies Markdown code blocks
- Correctly identifies Markdown links

3.1（满分 5 分）

7 个评分

Works well

But it should allow user input for the character widths others are requesting.

Additionally, using Swift, which is rather popular these days, most comments are indented, but when wrapping with this plugin, all lines after the first are *not* automatically indented, nor do they utilize compensation for indenting after the fact.

Needs work

Useless to me, since my line widths are 100 chars, and the extension only supports 40, 60 or 80. Worse, if I select comment lines wrapped to 100 chars and try to wrap them to 80, it doesn't wrap correctly.
I realize people use different line widths, but does _anyone_ use less than 80 chars? The 40 and 60 options seem silly. Why not remove those and add 100 and 120?
Even better, give the app itself a minimal UI that allows customizing the wrap width.

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.