Write article on coding standards / best practices

Bug #1209565 reported by Richard Gomes
12
This bug affects 1 person
Affects Status Importance Assigned to Milestone
JQuantLib
Won't Fix
High
Richard Gomes

Bug Description

Write article on coding standards / best practices

=============
Relationships
=============
has duplicate http://bugs.launchpad.net/bugs/jquantlib-182

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

Some ideas to be written down:

1. "private final" on fields
2. "final" on method parameters
3. use private on methods wherever possible and if in doubt; use final on methods wherever possible
4. avoid "static" wherever possible
5. Code formatting: Eclipse default but 160(?) caracters long
6. Comments and well organized code
7. Code visually pleasant to be read
8. License, copyrights
9. FastUtil: how to use it wisely
10. @ReadOnly to the receiver (equivalent to "const" return type)
11. JSR-308 annotations in general
12. Porting templates to generics (techniques)
13. Use primitive types wherever possible
14. solving issues pointed out by PMD and FindBugs
15. ???

Open discussion:
a. paralellism
b. colt .vs. parallel colt
c. ???

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

Colt and Fastutil were removed from JQuantLib.

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

duplicated of issue #182

I've reviewed the [initial] list of everything we need to document
http://bugs.jquantlib.org/view.php?id=182

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

Duplicates of this bug

Other bug subscribers

Remote bug watches

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