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:
| Item | Description |
|---|---|
| Language | Choose 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 Style | Choose 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: |
| Item | Description |
|---|---|
| Use tab character |
|
| Smart tabs |
The Smart Tabs checkbox is available if the Use tab character checkbox is selected. |
| Tab size | In this field, specify the number of spaces included in a tab. |
| Indent | In this field, specify the number of spaces to be inserted for each indent level. |
| Continuation indent | In 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 list | If 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 classes | In 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 preview.
Alignment takes precedence over indentation options.
Right Margin (columns)
Use the Hard wrap at field to specify a margin space required on the right side of an element. If you select 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. You can select one the following options:
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.
| Item | Description | By default |
|---|---|---|
| Line breaks | If 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 column | If 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 column | If 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 line | If 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 line | If 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 line | If 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 line | If 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 line | If 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, or assignment statements).
| Item | Description |
|---|---|
| Wrapping style | From this list, select the desired wrapping style:
|
Alignment options
| Item | Description |
|---|---|
| Align when multiline | If 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 line | Select this checkbox to have the specified character or characters moved to the next line when the lines are wrapped. |
| 'else' on new line | Use 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, Otherwise, |
| Indent case branches | If 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
| Item | Description |
|---|---|
| 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:
|
| Force braces | From this list, choose the braces introduction method for
|
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.
| Item | Description |
|---|---|
| Keep Maximum Blank Lines | In this area, specify the number of blank lines to be kept after reformatting in the specified locations. |
| Minimum Blank Lines | In the text boxes 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
| Item | Description |
|---|---|
| Line comment at first column | Select this checkbox to have generated line comments placed in the first column. |
| Add a space at comment start | Select 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 column | Select this checkbox to have generated block comments placed in the first column. |
Objective-C
| Item | Description |
|---|---|
| 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 implementation | Select this checkbox to insert a semicolon after method signature when generating method implementation. |
| Put ivars to implementation if possible | Select this checkbox to insert instant variables where possible when generating implementation. |
| Use NSInteger and CGFloat in introduce variable | Select 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:
|
| Generate ivar declarations for properties | Choose the behaviour for generating instant variable declarations for properties. The available options are:
|
C++
| Item | Description |
|---|---|
| Prefix for fields | Type the prefix that will prepend a name of an automatically generated field. |
| Suffix for fields | Type the suffix that will be appended to a name of an automatically generated field. |
| Prefix for getters | Type a prefix that will prepend a name of an automatically generated getter. The default name is get |
| Prefix for setters | type 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
| Item | Description |
|---|---|
| Add @brief tag | Select this checkbox to enable the @brief tag in Doxygen style comments. |
| Tag prefix in line comments | Click @param or \param option to select the preferred prefix type. |
| Tag prefix in block comments | Click @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.| Item | Description |
|---|---|
| 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 Extension | From the list, choose the extension to be associated with the source files. |
| Header Extension | From the list, choose the extension to be associated with the header files. |
| File Naming Convention | Choose 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. |
| Item | Shortcut | Description |
|---|---|---|
 | ⌘N | Click 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. |
 | ⌥⌦ | Click this button to remove the selected source/header file types pair from the list. |
  | ⌥↑ or ⌥↓ | Use these buttons to move the selected source/header file types pair up and down in the list. |