The document provides coding style guidelines for various programming languages and elements of code. It discusses indentation, white space, naming conventions, declarations, comments, and other style topics. The guidelines are intended to improve code readability and maintainability. Specific recommendations are given for line lengths, blank lines, alignment, placement of code elements, comment formats, and other style choices. Attribution is given for the sources of the different style guidelines.

1. *
* splash@dei.uc.pt 26
February
2011

3. bonus tips

6. “
”

7. 1 Indentation
1.1 Line length
1.2 Wrapping lines
1.3 Alignment
2 White space
2.1 Blank lines
2.2 Blank spaces
2.3 Trailing white space
3 Naming conventions
4 Declarations
4.1 Placement
5 Dead Code
6 Comments
6.1 Special comments
7 Parenthesis

8. 1 - Indentation

9. 1 - Indentation
Because it is a Java language coding
standard presented in the Java
Language Specification, from Sun
Microsystems

10. 1 - Indentation
Because of line wrapping,
which will be explained
later on

11. 1 - Indentation
Because it is the
Ruby convention

12. 1 - Indentation
Just because it makes
your life easier

13. 1 - Indentation

14. 1.1 – Indentation – Line length
How it looks like using
90 cols per line

15. 1.2 – Indentation – Wrapping lines

16. 1.3 – Indentation – Alignment

17. 1.3 – Indentation – Alignment

18. 2.1 – White space - Blank lines

19. 2.2 – White space - Blank spaces

20. 2.2 – White space - Blank spaces

21. 2.3 – White space – Trailing white space
http://andrei.gmxhome.de/anyedit/

22. 3 – Naming conventions

23. 3 – Naming conventions

24. 4.1 – Declarations – Placement

25. 5 – Dead Code

26. 6.1 – Comments – Special comments

27. 7 – Parenthesis
By Noel Rappin, from http://www.pathf.com/blogs/2008/10/elements-of-ruby-style/.

28. 7 – Parenthesis
By Noel Rappin, from http://www.pathf.com/blogs/2008/10/elements-of-ruby-style/.

29. 7 – Parenthesis
By Noel Rappin, from http://www.pathf.com/blogs/2008/10/elements-of-ruby-style/.

31. 1 – Commit messages

32. 1 Reverting
2 Messages

33. 1 – Reverting
DEV 1
DEV 2
By Taryn, from http://rubyglasses.blogspot.com/2007/08/actsasgoodstyle.html.

34. 2 – Messages
By Taryn, from http://rubyglasses.blogspot.com/2007/08/actsasgoodstyle.html.

35. 1 Models
2 Views
3 Controllers

36. 1 – Models
By Taryn, from http://rubyglasses.blogspot.com/2007/08/actsasgoodstyle.html.

37. 1 – Models
By Taryn, from http://rubyglasses.blogspot.com/2007/08/actsasgoodstyle.html.

38. 1 – Models
By Taryn, from http://rubyglasses.blogspot.com/2007/08/actsasgoodstyle.html.

39. 2 – Views
By Neeraj Choudhary, from http://scribd.com/doc/2889649/Rails-coding-standards-defined.

40. 3 – Controllers
By Taryn, from http://rubyglasses.blogspot.com/2007/08/actsasgoodstyle.html.

41. *
* splash@dei.uc.pt 26
February
2011