...
- Unit tests
Documentation
- Comments
- JavaDoc
- Other
- Help
Release
- FeaturesPlugin
- Deploying new pluginsFeature
Eclipse UI Best Practices
http://wiki.eclipse.org/index.php/UI_Best_Practices_v3.x
Java Coding Standards
We follow the Sun Java code conventions:
http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html
...
- Package names start with edu.stanford.slac.
...
JavaDoc Guidelines
http://java.sun.com/j2se/javadoc/writingdoccomments/index.html
Additional guidelines:
- All fields and methods (incl. those that are private) should have JavaDoc comments.
Releasing a new plugin
- Increment the version of your plugin.
- Check out all features from CVS into your Workspace.
- Delete features from the target directory. (but NOT the plugins!) Note: This is a very wrong step that seems to originate from an Eclipse bug in how features are built against a target.
- Increment the version of each updated feature.
- Remove plugins/features from the update site.
- Export RELEASE feature to SEAL update site (Export... => Plug-in Development => Deployable features)
- Check out the "update.seal" project from CVS.
- Update the names and versions of the features in site.xml.
- Export site.xml to SEAL update site. (Export => General => File System)
- Start SEAL in "admin"- mode.
- Update SEAL.
- Build JavaDoc. (optional)
- Commit all changes to CVS.
- Remove all old plugins from the installation site.
- Remove all unnecessary projects from your workspace.
- Reload your Plug-in Development target.
...