This document provides:
- General coding guidelines for
...
- the Juneau development team.
Table of Contents |
---|
1 - Code formatting
1.1 - Code formatting rules file
If you're using Eclipse, all the code formatting rules are already loaded into your workspace when you load the projects.
...
If you are using IntelliJ or NetBeans, there appear to be plugins that can be used to import these rules into your IDE. If anyone has any luck with these, please post the information here.
1.2 - Java
...
rules
- Tabs.
- All public and protected classes, methods, and fields should have Javadocs.
- Line length: 120.
2 - External and Internal APIs
All classes are considered public API except for the following exceptions:
- Private or package-protected classes/methods.
- Classes located in packages containing the name "internal" or "proto".
- Public or protected classes/method marked as internal-use-only in the Javadocs.
Refer to Versioning guidelines for information about when you are allowed to make changes to external APIs.
3 - Copyrights
Here are the copyright statements to use for each language. All files (even test comparison files) must have copyright statements to get past the Apache RAT tool.
...