Coding Guidelines & Best Practices
Upcoming SlideShare
Loading in...5
×
 

Coding Guidelines & Best Practices

on

  • 346 views

 

Statistics

Views

Total Views
346
Views on SlideShare
345
Embed Views
1

Actions

Likes
0
Downloads
3
Comments
0

1 Embed 1

http://a0.twimg.com 1

Accessibility

Categories

Upload Details

Uploaded via as Apple Keynote

Usage Rights

© All Rights Reserved

Report content

Flagged as inappropriate Flag as inappropriate
Flag as inappropriate

Select your reason for flagging this presentation as inappropriate.

Cancel
  • Full Name Full Name Comment goes here.
    Are you sure you want to
    Your message goes here
    Processing…
Post Comment
Edit your comment
  • \n
  • \n
  • \n
  • \n
  • \n
  • \n
  • \n
  • \n
  • \n

Coding Guidelines & Best Practices Coding Guidelines & Best Practices Presentation Transcript

  • Coding Guidelines & BestPracticesSerkan DemirelASSETS Plenary, Madrid, February 2011
  • Agenda• Why this presentation?• Code Readability• Code Documentation• Repository Cleaning• Managed Code• Upcoming Changes
  • Why this presentation?• Understanding• Integrating• Maintaining 3
  • Code Readability• Meaningful names• Nesting/Indention• Length• Code smell 4
  • Code Documentation• Javadocs (@author name + email address)• Interfaces• Classes• Deprecation 5
  • 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
  • Managed Code• Preferably no JNI calls• Preferably no Runtime.exec()• Unless agreed by Europeana 7
  • Upcoming Changes• Code coverage %• Checkstyle points• Frequent code reviews 8
  • - End - 9