草庐IT

xcode4 - XCode 4 注释格式(换行)

coder 2023-04-23 原文

我认为多行注释最好是这样的:

/* this is a mult-line comment, which wraps lines at some reasonable length,
 * usually approximately 80 characters. this way, comments are easy to read
 * and, with any half way capable text editor, easy to edit without having
 * to manually reshuffle lines, line breaks, and the comment leader. */

// this is a mult-line comment, which wraps lines at some reasonable length,
// usually approximately 80 characters. this way, comments are easy to read
// and, with any half way capable text editor, easy to edit without having
// to manually reshuffle lines, line breaks, and the comment leader.

/* this is a mult-line comment, which wraps lines at some reasonable length,
   usually approximately 80 characters. this way, comments are easy to read
   and, with any half way capable text editor, easy to edit without having
   to manually reshuffle lines, line breaks, and the comment leader. */

但是，XCode 不支持以这种风格管理评论。您必须在正确的时间手动按回车键以适当的宽度包装评论，然后编辑它们成为完整的 PITA。

或者，您永远不会按回车键并让编辑器将其包装在编辑器屏幕的边缘。但如果你像我一样，你的编辑器比理想的自动换行行长度要宽得多。

此外，XCode 通过提供一个在编辑器中以 80 个字符呈现包装指南的功能来 mock 我，但这纯粹是一个视觉功能，没有任何机制来支持它。这感觉就像把一把花园铲子交给习惯使用反铲的人。

我是否需要在这里进行实际检查 - 我的想法是否错误 - 还是 XCode 极度缺乏基本的段落式注释格式？

经验丰富、负责任、专业的 Objective-C 开发人员在代码中发表大量注释时会怎么做？帮我看看这里的光。

注意:对于 XCode 3，我编写了一个手卷脚本，它重新格式化文本并将其绑定(bind)到一个热键。我还没有弄清楚如何在 XCode 4 中做到这一点。但是如何编写 XCode 4 脚本与这个问题有点正交:必须用这些基础知识来扩充 IDE 听起来很糟糕，我的问题是关于 XCode 开发人员的风格和文化期望。

感谢您的建议。

最佳答案

我同意它应该内置在 Xcode 中。但无论如何，这里是如何通过创建一个调用脚本的服务项并为其分配键盘快捷键来快速将其添加到 Xcode4:

  1. 打开 Automator。创建服务。
  2. 将服务设置为让输出替换所选文本，并在您选择的 Xcode 副本中接收所选文本。
  3. 将“运行 Shell 脚本”操作拖入您的服务中作为唯一操作。
  4. 将默认的 shell 脚本“cat”替换为“fmt -n -s -p -w80”。这会调用 fmt 实用程序来重新格式化您的文本，允许行以句点开头，折叠行内的空格，允许缩进段落，在 80 个字符列处换行。查看 fmt 的手册页以了解其他选项。显然，您可以在这里通过 emacs 或 markdown 或其他方式传递文本来发疯。
  5. 使用合理的名称保存服务，例如“Reformat-to-80”

现在，当您在 Xcode 中选择文本后，您可以通过菜单栏选择服务将其重新格式化为 80 个字符:Xcode/Services/Reformat-to-80。

现在让我们为其分配一个键盘快捷键:

  1. 打开键盘首选项 Pane ，转到键盘快捷键选项卡。
  2. 在左侧 Pane 中选择应用程序快捷方式。
  3. 在右侧 Pane 中，使用添加按钮(+)为您之前选择的 Xcode 副本添加新的快捷方式。输入您用于服务的确切名称并添加您选择的键盘快捷键。

现在，在 Xcode 中，您可以使用该键盘快捷键将所选文本替换为 shell 脚本的输出，这会将文本重新格式化为

关于xcode4 - XCode 4 注释格式(换行)，我们在Stack Overflow上找到一个类似的问题： https://stackoverflow.com/questions/7353097/

xcode4xcodesectioncommentformattingcomments

有关xcode4 - XCode 4 注释格式(换行)的更多相关文章

  1. ruby - 使用 ruby​​ 将 HTML 转换为纯文本并维护结构/格式 - 2

    我想将html转换为纯文本。不过，我不想只删除标签，我想智能地保留尽可能多的格式。为插入换行符标签，检测段落并格式化它们等。输入非常简单，通常是格式良好的html(不是整个文档，只是一堆内容，通常没有anchor或图像)。我可以将几个正则表达式放在一起，让我达到80%，但我认为可能有一些现有的解决方案更智能。 最佳答案 首先，不要尝试为此使用正则表达式。很有可能你会想出一个脆弱/脆弱的解决方案，它会随着HTML的变化而崩溃，或者很难管理和维护。您可以使用Nokogiri快速解析HTML并提取文本:require'nokogiri'h

  2. ruby - 如何在 Lion 上安装 Xcode 4.6，需要用 RVM 升级 ruby - 2

    我实际上是在尝试使用RVM在我的OSX10.7.5上更新ruby，并在输入以下命令后:rvminstallruby我得到了以下回复:Searchingforbinaryrubies,thismighttakesometime.Checkingrequirementsforosx.Installingrequirementsforosx.Updatingsystem.......Errorrunning'requirements_osx_brew_update_systemruby-2.0.0-p247',pleaseread/Users/username/.rvm/log/138121

  3. ruby-on-rails - 将 Ruby 中的日期/时间格式化为 YYYY-MM-DD HH :MM:SS - 2

    这个问题在这里已经有了答案:Railsformattingdate(4个答案)关闭4年前。我想格式化Time.Now函数以显示YYYY-MM-DDHH:MM:SS而不是:“2018-03-0909:47:19+0000”该函数需要放在时间中.现在功能。require‘roo’require‘roo-xls’require‘byebug’file_name=ARGV.first||“Template.xlsx”excel_file=Roo::Spreadsheet.open(“./#{file_name}“,extension::xlsx)xml=Nokogiri::XML::Build

  4. ruby - 我可以将我的 README.textile 以正确的格式放入我的 RDoc 中吗？ - 2

    我喜欢使用Textile或Markdown为我的项目编写自述文件，但是当我生成RDoc时，自述文件被解释为RDoc并且看起来非常糟糕。有没有办法让RDoc通过RedCloth或BlueCloth而不是它自己的格式化程序运行文件？它可以配置为自动检测文件后缀的格式吗？(例如README.textile通过RedCloth运行，但README.mdown通过BlueCloth运行) 最佳答案 使用YARD直接代替RDoc将允许您包含Textile或Markdown文件，只要它们的文件后缀是合理的。我经常使用类似于以下Rake任务的东西:

  5. ruby - 是否有用于序列化和反序列化各种格式的对象层次结构的模式？ - 2

    给定一个复杂的对象层次结构，幸运的是它不包含循环引用，我如何实现支持各种格式的序列化？我不是来讨论实际实现的。相反，我正在寻找可能会派上用场的设计模式提示。更准确地说:我正在使用Ruby，我想解析XML和JSON数据以构建复杂的对象层次结构。此外，应该可以将该层次结构序列化为JSON、XML和可能的HTML。我可以为此使用Builder模式吗？在任何提到的情况下，我都有某种结构化数据-无论是在内存中还是文本中-我想用它来构建其他东西。我认为将序列化逻辑与实际业务逻辑分开会很好，这样我以后就可以轻松支持多种XML格式。 最佳答案 我最

  6. ruby-on-rails - 事件管理员日期过滤器日期格式自定义 - 2

    是否有简单的方法来更改默认ISO格式(yyyy-mm-dd)的ActiveAdmin日期过滤器显示格式？ 最佳答案 您可以像这样为日期选择器提供额外的选项，而不是覆盖js:=f.input:my_date,as::datepicker,datepicker_options:{dateFormat:"mm/dd/yy"} 关于ruby-on-rails-事件管理员日期过滤器日期格式自定义，我们在StackOverflow上找到一个类似的问题： https://s

  7. ruby-on-rails - 如何在 Rails 中设置路由的默认格式？ - 2

    路由有如下代码:resources:orders,only:[:create],defaults:{format:'json'}resources:users,only:[:create,:update],defaults:{format:'json'}resources:delivery_types,only:[:index],defaults:{format:'json'}resources:time_corrections,only:[:index],defaults:{format:'json'}是否可以使用1个字符串为所有资源设置默认格式，每行不带“默认值”散列？谢谢。

  8. ruby-on-rails - Rails 4 WYSIWYG Bootsy 不显示格式 - 2

    我刚刚按照thebootsygempage上的安装说明进行操作在我保存并查看帖子内容之前，一切看起来都不错。这是输出在View中的样子:HeaderSubhead:似乎没有呈现任何html格式，因为它被引号或类似的东西转义了-其他人有这个问题吗？我没有在github页面或SO上看到任何问题来指出我正确的方向。除了遵循gem安装说明之外，我还没有做任何事情，但也许我错过了什么或者只是犯了一个愚蠢的错误。如果你还有什么想知道的，请尽管问。干杯 最佳答案 你需要有这样的东西，转义html: 关

  9. ruby - 在 Ruby 中将整数格式化为固定长度的字符串 - 2

    有没有一种简单的方法可以将给定的整数格式化为具有固定长度和前导零的字符串？#convertnumberstostringsoffixedlength3[1,12,123,1234].map{|e|???}=>["001","012","123","234"]我找到了解决方案，但也许还有更聪明的方法。format('%03d',e)[-3..-1] 最佳答案 如何使用%1000而不是进行字符串操作来获取最后三位数字？[1,12,123,1234].map{|e|format('%03d',e%1000)}更新:根据theTinMan的

  10. ruby-on-rails - 如何正确格式化字符串，如 'mccdougal' 到 'McDougal' - 2

    什么Ruby或RailsDSL会将字符串"mccdougal"格式化为"McDougal"，同时留下字符串"McDougal"原样？将titleize传递给"McDougal"结果如下:"McDougal".titleize#=>"McDougal" 最佳答案 据我所知，没有可以处理这种情况的Rails助手。这是一个非标准的边缘案例，需要特殊处理。但是，您可以创建自定义字符串变形。您可以将这段代码放入初始化程序中:ActiveSupport::Inflector.inflections(:en)do|inflect|inflect.

随机推荐