Code Style. C/C++/Objective C
Use this page to configure
formatting
options for C, C++, Objective C files. View the result in the
Preview
pane on the right.
On this page:
Set from
Click this link to choose the base for the current language default code style from the pop-up 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.
So doing, 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:
|
Tabs and Indents
Item | Description |
---|
Use tab character |
-
If this check box is selected, tab characters are used:
- On pressing the ⇥ key
- For indentation
- For code reformatting
-
When the check box is cleared, AppCode uses spaces instead of tabs.
|
Smart tabs |
-
If this check box is selected, AppCode inserts tabs for indentation and reformatting.
AppCode inserts tabs in the beginning of each line
until a symbol other than the tab is inserted. After that when you press the tab key,
AppCode will enter spaces.
-
If this check box 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 check box is available if the
Use Tab Character check box is selected.
|
Tab size | In this text box, specify the number of spaces included in a tab. |
Indent | In this text box, specify the number of spaces (or tabs if the
Use Tab Character
check box is selected) to be inserted for each indent level.
|
Continuation indent | In this text box, specify the number of spaces (or tabs if the
Use Tab Character check box is selected) to be inserted between the elements
of an array, in expressions, method declarations and method calls. |
Indent members of 'namespace' | In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected)
to be inserted before each member of a 'namespace'. |
Indent members of '@interface' and '@protocol' | In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected)
to be inserted before each member of '@interface' and '@protocol'. |
Except instance variables list | If this check box is selected, the instance variables list of '@interface' and '@protocol' is not indented. |
Indent members of '@implementation' | In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected)
to be inserted before each member of an '@implementation'. |
Indent visibility keywords in classes | In this text box, specify the number of spaces (or tabs if the Use Tab Character check box is selected)
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 check box 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, etc.).
The right-hand pane shows preview.
Alignment takes precedence over indentation options.
Right Margin (columns)
Use Right Margin 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 Wrap on typing settings to specify how the edited text is fitted in the
specified Right margin.
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.
Keep When Reformatting
Use the check boxes to configure exceptions that AppCode will make when reformatting the source code.
For example, by default, the Line breaks check box is selected. If your code contains lines that are shorter than a
standard convention, you can convert them by disabling the Line breaks check box before you reformat the source code.
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 drop-down list, select the desired wrapping style:
|
Alignment Options
Item | Description |
---|
Align when multiline |
If this check box 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 parenthesised when multiline |
If this check box is selected, a parenthesised code construct starts at the column of the opening
parenthesis each next line. Otherwise, the position of a code construct is determined by the
current indentation level.
|
Align in columns |
If this check box 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 check box to have the specified character or characters moved to the next line when the lines are wrapped. |
'else' on new line | Use this check box to have the corresponding statements or characters moved to the next line. |
New line after <character>
| Select this check box to have the code after the specified character moved to a new line. |
Special else if treatment | If this check box 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 branches |
If this check box 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 drop-down 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 drop-down list, choose the braces introduction method for if , for ,
while , and do () while statements. The available options are:
|
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.
General
Item | Description |
---|
Line comment at first column | Select this check box to have generated line comments placed in the first column. |
Block comment at first column | Select this check box 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 check box 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 check box 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 check box to insert a semicolon after method signature when generating method
implementation.
|
Put ivars to implementation if possible | Select this check box to insert instant variables where possible when generating
implementation.
|
Use NSInteger and CGFloat in introduce variable | Select this check box 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 properties |
Choose the behaviour for generating instant variable declarations for properties. The available options are:
- Always generate
- Never generate
- Ask
|
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
|
Note:
Prefix and Suffix for fields settings are intended for refactorings and are not applicable for the code generation.
Last modified: 20 July 2016