CodingStandards

From Ratwiki

Jump to: navigation, search

J2Menace aims to be high-quality software and as such, tight conding standards are required.

  • Starting point is Sun's own coding conventions: http://java.sun.com/docs/codeconv/
  • For consistency with the rest of J2ME, properties, methods, class names and so on should all be written using American spelling, though comments can be written in any English variant
  • API should be clean, consistent, null safe (where applicable) and not throw checked exceptions without very good reason.
  • Every property, method, class and interface should have a javadoc block regardless of visibility
Personal tools