Difference between revisions of "Coding guideline"
(Created page with "====== Coding guidlines ====== ===== General Conventions ===== * Comment your code (documentation_guidelines) * One File - One Class * Don't add packages with a w...") |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 7: | Line 7: | ||
* Don't add packages with a wildcard (e.g. java.lang.* - instead always type the whole package name java.lang.Integer) | * Don't add packages with a wildcard (e.g. java.lang.* - instead always type the whole package name java.lang.Integer) | ||
* Produce readable code | * Produce readable code | ||
| − | * | + | * Produce efficient code |
* (in this order - first readability, then efficiency) | * (in this order - first readability, then efficiency) | ||
| Line 14: | Line 14: | ||
camel case + (reduced) hungarian notation = ARS coding guidline | camel case + (reduced) hungarian notation = ARS coding guidline | ||
| − | example camel case: clsHeimoZeilinger (new word --> capital letter)\\ | + | *example camel case: clsHeimoZeilinger (new word --> capital letter)\\ |
| − | example hungarian : mnCountOfHeimos (m for member, n typeof integer)\\ | + | *example hungarian : mnCountOfHeimos (m for member, n typeof integer)\\ |
| − | + | *[[http://en.wikipedia.org/wiki/Hungarian_notation|Hungarian notation - Wikipedia]] | |
Basics in (reduced) hungarian notation: | Basics in (reduced) hungarian notation: | ||
1st letter: | 1st letter: | ||
| − | + | ||
| − | + | *m ... member | |
| − | + | *p ... method parameter | |
| − | + | *i ... interface parameter | |
| − | + | *s ... static variable | |
| − | + | *blank ... function scope | |
| − | + | ||
| − | + | ||
2nd letter: | 2nd letter: | ||
| − | + | ||
| − | b ... boolean | + | *b ... boolean |
| − | e ... enum | + | *e ... enum |
| − | n ... number (integer, long) | + | *n ... number (integer, long) |
| − | r ... real (floating point, double) | + | *r ... real (floating point, double) |
| − | o ... object (also string) | + | *o ... object (also string) |
| − | g ... generic | + | *g ... generic |
| − | + | ||
| − | + | ||
===== File notation (java/eclipse) ===== | ===== File notation (java/eclipse) ===== | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | + | *clsXYZ ... Classe Files | |
| − | + | *XYZ ... Class Files that contain the method //public static main(String args[])// and that are meant to be used to start the application | |
| + | *itfXYZ ... Java Interface | ||
| + | *tstXYZ ... junit Test Cases | ||
| + | *tssXYZ ... junit Test Suites | ||
Latest revision as of 18:01, 2 January 2013
Contents
Coding guidlines
General Conventions
* Comment your code (documentation_guidelines) * One File - One Class * Don't add packages with a wildcard (e.g. java.lang.* - instead always type the whole package name java.lang.Integer) * Produce readable code * Produce efficient code * (in this order - first readability, then efficiency)
Naming Conventions
camel case + (reduced) hungarian notation = ARS coding guidline
- example camel case: clsHeimoZeilinger (new word --> capital letter)\\
- example hungarian : mnCountOfHeimos (m for member, n typeof integer)\\
- [notation - Wikipedia]
Basics in (reduced) hungarian notation:
1st letter:
- m ... member
- p ... method parameter
- i ... interface parameter
- s ... static variable
- blank ... function scope
2nd letter:
- b ... boolean
- e ... enum
- n ... number (integer, long)
- r ... real (floating point, double)
- o ... object (also string)
- g ... generic
File notation (java/eclipse)
- clsXYZ ... Classe Files
- XYZ ... Class Files that contain the method //public static main(String args[])// and that are meant to be used to start the application
- itfXYZ ... Java Interface
- tstXYZ ... junit Test Cases
- tssXYZ ... junit Test Suites
