PTP/policy/developer guidelines

From Eclipsepedia

< PTP‎ | policy
Revision as of 13:26, 30 October 2007 by G.watson.computer.org (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

PTP adheres to the Eclipse Foundation development conventions and guidelines. Please make sure you read through these before committing code (if you're a committer) or submitting code contributions (if not).

The following practices should also be observed:

Additional requirements for Java source:

  • All interfaces and methods must include a Javadoc comment
  • Interface implementations must include a non-Javadoc comment

Additional requirements for C source:

  • All functions must be commented
  • Only include header files that are explicitly used
  • Always initialize variables before use (including static)
  • Always test explicitly for NULL
  • Always use NULL for pointers, not 0
  • Always test for an explicit value from strcmp