Your SlideShare is downloading. ×
0
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                             ...
Repository Cleaning• Prevent commented out code• Use todo keyword instead• Remove unused code• Deprecation lifecycle• No b...
Managed Code• Preferably no JNI calls• Preferably no Runtime.exec()• Unless agreed by Europeana                           ...
Upcoming Changes• Code coverage %• Checkstyle points• Frequent code reviews                                       8
- End -          9
Upcoming SlideShare
Loading in...5
×

Coding Guidelines & Best Practices

313

Published on

Published in: Technology
0 Comments
0 Likes
Statistics
Notes
  • Be the first to comment

  • Be the first to like this

No Downloads
Views
Total Views
313
On Slideshare
0
From Embeds
0
Number of Embeds
0
Actions
Shares
0
Downloads
7
Comments
0
Likes
0
Embeds 0
No embeds

No notes for slide
  • \n
  • \n
  • \n
  • \n
  • \n
  • \n
  • \n
  • \n
  • \n
  • Transcript of "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
    1. A particular slide catching your eye?

      Clipping is a handy way to collect important slides you want to go back to later.

    ×