如何格式化Xcode中的代码包括MarkUps

时间:2017-03-12 00:32:21

标签: swift xcode formatting comments markup

我知道使用Xcode可以使用编辑器 - >格式化代码。结构 - >重新缩进我遇到的问题是当我想重新缩进我的所有代码,包括像这样的markUps:

/**
     Append new motive to motives array
     - parameters:
        - name: A brief description of motive.
     - returns: false if is empty otherwise true
*/

注意:如果我选择所有代码并重新识别它,MarkUp代码将如下所示:

/**
     Append new motive to motives array
     - parameters:
     - name: A brief description of motive.
     - returns: false if is empty otherwise true
*/

这会影响显示的快速帮助,我在缩进之前和之后添加了两张图片。

缩进前快速帮助:

Before Indent Quick Help

缩进后快速帮助:

enter image description here

看看缩进我的代码之后,快速帮助不会显示,因为它需要从- parameters:一个标签缩进,因此特别要查看它消失的参数行。

问题是如何缩进我的代码,包括对MarkUps的适当缩进,或者如何选择我的所有代码缩进但不影响MarkUps。

1 个答案:

答案 0 :(得分:0)

看起来还有一些尚未解决的错误。 我建议使用下面的方法来描述参数。

基本(与Apple Development相同)

<ListView ...
          Background="Transparent">
    <ListView.Resources>
        <Style TargetType="GridViewColumnHeader">
            <Setter Property="Background" Value="Transparent" />
        </Style>
    </ListView.Resources>
    <ListView.View>
        <GridView>
            <GridViewColumn .../>
        </GridView>
    </ListView.View>
</ListView>

但我更喜欢使用XCode的自动缩进。

使用自动缩进(推荐方式)

/**
 Append new motive to motives array

 - parameters name: A brief description of motive
 - parameters opt: A options

 - returns: false if is empty otherwise true
 */
public func exampleFunc(_ name: String, options opt: Options) {
  ...
}

即使使用自动缩进,也会使格式始终相同。