Skip to content
Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
48 lines (33 sloc) 1.89 KB
Root.Formatting Parent Index
Sibling aspects Metadata Redundancy Security Smell Spelling

Formatting

The visual appearance of source code.

Subaspects

Example

# Here is an example of Python code with lots of
# formatting issues including: trailing spaces, missing spaces
# around operators, strange and inconsistent indentation etc.

z = 'hello'+'world'
     def f ( a):
        pass

Importance

A coding style (the of rules or guidelines used when writing the source code) can drastically affect the readability, and maintainability of a program and might as well introduce bugs.

How to fix this

Defining a clearly and thoughtful coding style (based on the available ones given the programming language in use) and strictly respect it or apply it through out the implementation of a project.

You can’t perform that action at this time.