Write article on coding standards

Bug #1209676 reported by Richard Gomes
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
JQuantLib
New
Medium
Unassigned

Bug Description

1. "private final" on fields
 2. "final" on method parameters
 3. use private on methods wherever possible or when in doubt
 4. Use primitive types wherever possible
 5. avoid "static" wherever possible
 6. Code formatting: Eclipse default but 160(?) caracters long
 7. Comments and well organized code (sections of code)
 8. Code visually pleasant to be read
 9. License, copyrights
10. When singletons are needed and when they are bad.
11. annotations @Override, @Deprecated
12. annotations @NoThreadSafe
13. JSR-308 annotations
14. @ReadOnly to the receiver (equivalent to "const" return type)
15. Logging
16. test cases and howto on JUnit
17. PMD rules and why they are important
18. FindBugs reports and why they are important
19. "mvn clean verify" : why it is important
20. Clean up and double checking before committing code

Advanced Techniques
a. Porting templates to generics (techniques)
b. Using Super Type Tokens

=============
Relationships
=============
duplicate of http://bugs.launchpad.net/bugs/jquantlib-48
parent of http://bugs.launchpad.net/bugs/jquantlib-180
parent of http://bugs.launchpad.net/bugs/jquantlib-198

Revision history for this message
Richard Gomes (frgomes) wrote :

Could you help review the list of needed documentation?

We have an interim documentation at
http://www.jquantlib.org/index.php/Translation_Guidelines

Your feedback is important!

Thanks -- Richard

Revision history for this message
Richard Gomes (frgomes) wrote :

Reminder: explain that the library cannot have main().

Revision history for this message
Richard Gomes (frgomes) wrote :

dropped back to the pot

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.