Write article on coding standards / best practices
Bug #1209565 reported by
Richard Gomes
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://
To post a comment you must log in.
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. ???