Difference between revisions of "Code Formatting Conventions"

These are conventions which we try to follow when writing code for ScummVM. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.  

These are conventions which we try to follow when writing code for ScummVM. They are this way mainly for reasons of taste, however, sticking to a common set of formatting rules also makes it slightly easier to read through our sources. If you want to submit patches, please try to follow these rules.  

In the following examples tabs are replaced by spaces for visual consistency with the Code Formatting Conventions.

In the following examples tabs are replaced by spaces for visual consistency with the Code Formatting Conventions.

Braces in your code should look like the following example:

Braces in your code should look like the following example:

Did you see the {}'s on that?

Did you see the {}'s on that?

Says it all, really.

Says it all, really.

'''Conventional operators surrounded by a space character'''

'''Conventional operators surrounded by a space character'''

</pre>

</pre>

<pre>

<pre>

</pre>

</pre>

'''Constants'''

'''Constants'''

</pre>

</pre>

The following goes slightly beyond code formatting: We use certain keywords (together with an explanatory text) to mark certains sections of our code. In particular:

The following goes slightly beyond code formatting: We use certain keywords (together with an explanatory text) to mark certains sections of our code. In particular: