Giter VIP home page Giter VIP logo

xcodecommentwrapper's Introduction


Comment Wrapper
Comment Wrapper

min

An Xcode Source Editor extension that wraps your comments

2018-04-26 21_32_28

Want to edit your comments? Comment Wrapper can re-wrap edited comments

2018-04-26 21_45_41

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

Installation

Either:

Then:

  1. Run the application (you can quit it after this)
  2. Open System Preferences
  3. Open the Extensions pane
  4. Find CommentWrapper and enable Xcode Source Editor extension
  5. Highlight some code in Xcode and choose an action under Editor -> Comment Wrapper

Author

@SteveBarnegren

License

Comment Wrapper is available under the MIT license. See the LICENSE file for more info.

xcodecommentwrapper's People

Contributors

peter-schorn avatar stevebarnegren avatar winkelsdorf avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

xcodecommentwrapper's Issues

Request: Arbitrary line length + keyboard shortcuts

Thanks for your extremely useful extension.

Would it be possible to add an option to define an arbitrary line length (e.g., 100)?

It would also greatly improve workflow to have a keyboard shortcut bound to the various wrapping options - is that possible?

Thanks again!

Update for Big Sur

Hello Steve,

thanks for this great product. I saw that you updated it recently after my Review in the MAS. Thanks for that!

Unfortunately it still didn't work with Xcode 12 on Big Sur. This is due to XcodeKit.framework requiring now to be embedded & signed in the extension to work (saw that in the debugger output). I found a comparable issue here, where the Apple release notes for Xcode 12 are attached: fespinoza/HelloXcodeExtensions@ad4bf53.

I decided to create a fork and if you like have a look at my PR.

It fixes the embedding, fixes Dark Mode text colors on macOS and adjust minor things I noticed to better reflect the current Xcode defaults.

Now it works as it should :)

See linked PR.

hth!

All the best
Frederik

Multilingual support

当我在 Xcode 注释中输入中文字符时,格式化功能似乎失效了。


When I type Chinese characters in Xcode comments, the formatting function seems to have failed.

For example:

extension SearchViewController: URLSessionDelegate {
  // 当后台任务执行完成后,捕获这个委托方法提供的完成处理程序。调用完成处理程序告诉操作系统,你的应用程序已经完成了当前会话的所有后台活动的工作。它还会导致操作系统快照你更新的用户界面,以便在应用程序切换器中显示
  func urlSessionDidFinishEvents(forBackgroundURLSession session: URLSession) {
    DispatchQueue.main.async {
      if let appDelegate = UIApplication.shared.delegate as? AppDelegate,
         let completionHandler = appDelegate.backgroundSessionCompletionHandler {
        appDelegate.backgroundSessionCompletionHandler = nil
        completionHandler()
      }
    }
  }
}

Instructions for adding keyboard shortcuts for using comment wrapper

I love using Comment Wraper to save time. However, one of the things I hate is having to use the mouse which takes my hands off of the keyboard. If there were instructions or features within the app to add the keyboard shortcut, it would be really helpful! I would be willing to collaborate on adding the functionality.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.