Difference between revisions of "Coding guidelines"

From SIMA wiki
Jump to: navigation, search
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)
+
 
Origin [http://en.wikipedia.org/wiki/Hungarian_notation|Hungarian notation - Wikipedia]
+
example hungarian: mnCountOfHeimos (m for member, n typeof integer)
 +
 
 +
Origin: [http://en.wikipedia.org/wiki/Hungarian_notation|Hungarian notation - Wikipedia]

Revision as of 12:57, 16 October 2012

General Conventions

  1. Comment your code (documentation_guidelines)
  2. One File - One Class
  3. Don't add packages with a wildcard (e.g. java.lang.* - instead always type the whole package name java.lang.Integer)
  4. Produce readable code
  5. 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