Coding guideline

From SIMA wiki
Jump to: navigation, search

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
Personal tools
Namespaces

Variants
Actions
ARS - Wissen
Forum
Studentenaufgaben
Navigation
Toolbox