Difference between revisions of "Coding guidelines"
Line 10: | Line 10: | ||
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) |
− | Origin: [http://en.wikipedia.org/wiki/Hungarian_notation|Hungarian notation - Wikipedia] | + | ;Origin: [http://en.wikipedia.org/wiki/Hungarian_notation|Hungarian notation - Wikipedia] |
Revision as of 11:55, 16 October 2012
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)
- Origin
- notation - Wikipedia