AppCode 2021.2 Help

Code Style. C/C++/Objective-C

Use this page to configure formatting options for C, C++, Objective-C files. When you change these settings, the Preview pane shows how this will affect your code.

Set from

Click this link to choose the base for the current language default code style from the list, that appears. The list contains the following options:

ItemDescription
LanguageChoose this option to inherit the coding style settings from another language. Select the source language from the list that opens. In doing so, only the settings that are applicable to the current language are taken. All the other settings are not affected.
Predefined StyleChoose this option to use the coding styles defined for a specific framework or coding standard. Select one of the following standards from the list.

Note: the coding styles of the below set affect only the certain items of base settings and leave the rest of them unchanged.

The following styles of the list are applicable for braces placement only:

Tabs and Indents

ItemDescription
Use tab character
  • If this checkbox is selected, tab characters are used:

    • On pressing the key

    • For indentation

    • For code reformatting

  • When the checkbox is cleared, AppCode uses spaces instead of tabs.

Smart tabs
  • If this checkbox is selected, the part of indentation defined by the nesting of code blocks, is made of the tabs and (if necessary) spaces, while the part of indentation defined by the alignment is made only of spaces.

  • If this checkbox is cleared, only tabs are used. This means that a group of spaces that fits the specified tab size is automatically replaced with a tab, which may result in breaking fine alignment.

The Smart tabs checkbox is available if the Use tab character checkbox is selected.

Tab sizeIn this field, specify the number of spaces included in a tab.
IndentIn this field, specify the number of spaces to be inserted for each indent level.
Continuation indentIn this field, specify the number of spaces to be inserted between the elements of an array, in expressions, method declarations and method calls.
Indent members of 'namespace'In this field, specify the number of spaces to be inserted before each member of a 'namespace'.
Indent members of '@interface' and '@protocol'In this field, specify the number of spaces to be inserted before each member of '@interface' and '@protocol'.
Except instance variables listIf this checkbox is selected, the instance variables list of '@interface' and '@protocol' is not indented.
Indent members of '@implementation'In this field, specify the number of spaces to be inserted before each member of an '@implementation'.
Indent visibility keywords in classesIn this field, specify the number of spaces to be inserted before each visibility keyword in all classes.

Spaces

Use this tab to specify where you want spaces in your code. To have AppCode automatically insert a space at a location, select the checkbox next to this location in the list. The results are displayed in the preview pane.

Wrapping and braces

In this tab, customize the code style options, which AppCode will apply on reformatting the source code. The left-hand pane contains the list of exceptions (Keep when reformatting), and placement and alignment options for the various code constructs (lists, statements, operations, annotations, and so on) The right-hand pane shows the preview.

Alignment takes precedence over indentation options.

Hard wrap at

Use the Hard wrap at field to specify a margin space required on the right side of an element. If you select the Default option, then a value of the right margin from the global settings is used.

Wrap on typing

Use the Wrap on typing settings to specify how the edited text is fitted in the specified Hard wrap at:

  • Default: in this case AppCode uses the Wrap on typing option that is specified in the global settings.

  • Yes: in this case AppCode uses the value specified in the Right Margin field.

  • No: in this case this option is switched off and a line can exceed the value specified in the right margin.

Visual guides

Use the Visual guides field to specify multiple right margins. You can leave a default value or enter the number of spaces for your margin. If you want to specify several margins, enter numbers separated by comma.

Keep when reformatting

Use the checkboxes to configure exceptions that AppCode will make when reformatting the source code. For example, by default, the Line breaks checkbox is selected. If your code contains lines that are shorter than a standard convention, you can convert them by disabling the Line breaks checkbox before you reformat the source code.

ItemDescriptionBy default
Line breaksIf this option is selected, line breaks will be kept after reformatting the code. Otherwise, the lines that are shorter than a standard convention will be merged into one line.Selected
Comment at first columnIf this option is selected, comments placed at the first column won't change their position after reformatting the code. Otherwise, such comments will align with the next line of code.Selected
Directive at first columnIf this option is selected, directives placed at the first column won't change their position after reformatting the code. Otherwise, the directives will align with the surrounding code.Selected
Control statement in one lineIf this option is selected, control statements placed at the first column won't change their position after reformatting the code. Otherwise, the statements will align with the surrounding code.Selected
Simple blocks and lambdas in one lineIf this option is selected, simple single-line blocks and lambdas will be kept in one line after reformatting the code. Otherwise, they will expand into multiple lines.Deselected
Simple methods and functions in one lineIf this option is selected, simple methods and functions will be kept in line after reformatting the code. Otherwise, they will expand into multiple lines.Deselected
Classes and structures in one lineIf this option is selected, simple classes and structures will be kept in one line after reformatting the code. Otherwise, they will expand into multiple lines.Deselected
Keep nested namespaces in one lineIf this option is selected, nested namespaces will stay at the same line with the parent ones after reformatting the code. Otherwise, they will be moved to a new line.Deselected

Wrapping options

The wrapping style applies to the various code constructs, specified in the left-hand pane (for example, method call arguments, method declaration parameters, or assignment statements).

ItemDescription
Wrapping style

From this list, select the desired wrapping style:

  • Do not wrap: when this option is selected, no special wrapping style is applied.

    With this option selected, the nested alignment and braces settings are ignored.

  • Wrap if long: select this option to have lines going beyond the right margin wrapped with proper indentation.

  • Wrap always: select this option to have all elements in lists wrapped, so that there is one element per line with proper indentation.

  • Chop down if long: select this option to have elements in lists that go beyond the right margin wrapped, so that there is one element per line with proper indentation.

Alignment options

ItemDescription
Align when multilineIf this checkbox is selected, a code construct starts at the same column on each next line. Otherwise, the position of a code construct is determined by the current indentation level.
Align in columns

If this checkbox is selected, the variables names, types and initializers are aligned in columns, each variable on next line, as in example:

Before

var myName: String var myTitle: String var myOrderNumber: Int

After

var myName: String var myTitle: String var myOrderNumber: Int

<character(s)> on next lineSelect this checkbox to have the specified character or characters moved to the next line when the lines are wrapped.
'else' on new lineUse this checkbox to have the corresponding statements or characters moved to the next line.
New line after <character>Select this checkbox to have the code after the specified character moved to a new line.
Special else if treatment

If this checkbox is selected, else if statements are located in the same line.

Otherwise, else if statements are moved to the next line to the corresponding indent level.

Indent case branchesIf this checkbox is selected, the case statement is located at the corresponding indent level. Otherwise, case statement is placed at the same indent level with switch.

Braces placement options

ItemDescription
Braces placement style

Use this list to specify the position of the opening brace in class declarations, method declarations, and other types of declarations. The available options are:

  • End of line: select this option to have the opening brace placed at the declaration line end.

  • Next line if wrapped: select this option to have the opening brace placed at the beginning of the line after the multiline declaration line.

  • Next line: select this option to have the opening brace placed at the beginning of the line after the declaration line.

  • Next line shifted: select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level.

  • Next line, each shifted: select this option to have the opening brace placed at the line after the declaration line being shifted to the corresponding indent level, and have the next line shifted to the next indent level as well.

Force braces

From this list, choose the braces introduction method for if, for, while, and do () while statements. The available options are:

  • Do not force: select this option to suppress introducing braces automatically.

  • When multiline: select this option to have braces introduced automatically if a statement occupies more than one line. Note that AppCode analyzes the number of lines in the entire statement but not only its condition.

    For example, if the code is

    int foo (int Days) { if ((Days % 10) == 3) return 1; else return 0; }

    AppCode will insert braces automatically:

    int foo (int Days) { if ((Days % 10) == 3) { return 1; } else { return 0; } }
  • Always: select this checkbox to have braces always introduced automatically.

Blank lines

Use this tab to define where and how many blank lines you want AppCode to retain and insert in your code after reformatting. For each type of location, specify the number of blank lines to be inserted. The results are displayed in the preview pane.

ItemDescription
Keep maximum blank linesIn this area, specify the number of blank lines to be kept after reformatting in the specified locations.
Minimum blank lines

In this area, specify the number of blank lines to be present in the specified locations.

Code generation

Use this tab to configure formatting options for generated code.

Comment code

ItemDescription
Line comment at first columnSelect this checkbox to have generated line comments placed in the first column.
Add a space at comment startSelect this checkbox to have a space placed after // in generated line comments. This option is available only if the Line comment at first column checkbox is cleared.
Block comment at first columnSelect this checkbox to have generated block comments placed in the first column.
For more information on comments formatting, refer to Comments formatting.

Objective-C

ItemDescription

Prefix for instance variables

Suffix for instance variables

In these text boxes, type the prefixes and suffixes to be used when generating instance variables.
Retain object parameters in initWith...Select this checkbox to retain object parameters when generating initWith. This option will not work unless Automated Reference Counting is disabled.
Use property setters in initWith...Select this checkbox to use property setters when generating initWith. This option will not work unless instant variable has a synthesized property.
Semicolon after method signature in implementationSelect this checkbox to insert a semicolon after method signature when generating method implementation.
Put ivars to implementation if possibleSelect this checkbox to insert instant variables where possible when generating implementation.
Use NSInteger and CGFloat in introduce variableSelect this checkbox to use NSInteger and CGFloat in introduce variable. Otherwise int and float will be used.
Ivars release style (for 'dealloc')Choose instant variables release style for dealloc method. The available options are:
  • [ivar release]
  • [ivar release], ivar=nill
  • property=nill
Generate ivar declarations for propertiesChoose the behaviour for generating instant variable declarations for properties. The available options are:
  • Always generate
  • Never generate
  • Ask

C++

ItemDescription
Prefix for fieldsType the prefix that will prepend a name of an automatically generated field.
Suffix for fieldsType the suffix that will be appended to a name of an automatically generated field.
Prefix for gettersType a prefix that will prepend a name of an automatically generated getter. The default name is get
Prefix for setterstype a prefix that will prepend a name of an automatically generated setter. The default name is set
Generate != together with ==select this checkbox to enable this setting as default for Select Fields dialog when generating an equality operator.
Generate >,<=,>= together with <select this checkbox to enable this setting as default for Select Fields dialog when generation a relational operator.

Documentation comments

ItemDescription
Add @brief tagSelect this checkbox to enable the @brief tag in Doxygen style comments.
Tag prefix in line commentsClick @param or \param option to select the preferred prefix type.
Tag prefix in block commentsClick @param or \param option to select the preferred prefix type.

New File Extensions Tab

In this tab you can define the source/header file types used in the Create New C/C++ Source File dialog. This tab also determines the order of their appearance in the Type field of that dialog: the first pair in the tab is the first extension in the type list in dialog.
ItemDescription
Source/header file types pane.The list of source and header file types. All the code style rules specified under this node of Settings, are applicable to the listed file types.
Source ExtensionFrom the list, choose the extension to be associated with the source files.
Header ExtensionFrom the list, choose the extension to be associated with the header files.
File Naming ConventionChoose the preferred naming convention from the drop down list. This setting defines a case of the filename generated in the New C++ Class dialog when a new class is being created.
ItemShortcutDescription
Icons general add⌘ NClick this button to add a new source/header file types pair to the list. The new pair is always of .cpp/.h type. When added to the list, assign the desired extensions from the Source Extension/Header Extension dropdown lists to them.
Icons general remove⌥ ⌦Click this button to remove the selected source/header file types pair from the list.
Icons actions previous occurenceIcons actions next occurence⌥ ↑ or ⌥ ↓Use these buttons to move the selected source/header file types pair up and down in the list.
Last modified: 26 August 2021