Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
PTP/policy/developer guidelines
< PTP | policy
Revision as of 13:26, 30 October 2007 by Unnamed Poltroon (Talk) (New page: PTP adheres to the [http://wiki.eclipse.org/Development_Conventions_and_Guidelines Eclipse Foundation development conventions and guidelines]. Please make sure you read through these befor...)
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:
- All source files must start with an approved license and copyright declaration
- All plugins must include an about.html file
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