Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

Coding Guidelines & Best Practices


Published on

Published in: Technology
  • Be the first to comment

  • Be the first to like this

Coding Guidelines & Best Practices

  1. 1. Coding Guidelines & BestPracticesSerkan DemirelASSETS Plenary, Madrid, February 2011
  2. 2. Agenda• Why this presentation?• Code Readability• Code Documentation• Repository Cleaning• Managed Code• Upcoming Changes
  3. 3. Why this presentation?• Understanding• Integrating• Maintaining 3
  4. 4. Code Readability• Meaningful names• Nesting/Indention• Length• Code smell 4
  5. 5. Code Documentation• Javadocs (@author name + email address)• Interfaces• Classes• Deprecation 5
  6. 6. Repository Cleaning• Prevent commented out code• Use todo keyword instead• Remove unused code• Deprecation lifecycle• No binaries (with an exception of mock data)• No IDE/OS specific files 6
  7. 7. Managed Code• Preferably no JNI calls• Preferably no Runtime.exec()• Unless agreed by Europeana 7
  8. 8. Upcoming Changes• Code coverage %• Checkstyle points• Frequent code reviews 8
  9. 9. - End - 9