Stendhal code design

Stendhal code design

• General code design
• Structure of Server
• Structure of Client
• Structure of Web Client

• Play
  • Manual
  • Beginner's Guide
  • FAQ
  • Ask for Help
  • Events
  • Videos
  • Rules
  • Groups
• World
  • Atlas
  • Dungeons
  • NPCs
  • Levels
  • Creatures
  • Items
  • Quests
  • Games
  • History
  • Achievements
  • Houses
• GMs
  • Administration
  • How to be a GM
  • Scripts
  • Guide for admin
• Contribute
  • Chat
  • Bugs
  • Testing
  • Graphics
  • Sound
  • Item Ideas
  • Atlas
  • Creature Ideas
  • Quest Ideas
  • NPC Ideas
  • Events Ideas
  • Achievement Ideas
  • Open Tasks
• |
• Extend
  • How to add items
  • How to add Creatures
  • How to add quests
  • How to add NPCs
  • How to create maps
• Develop
  • CVS (Source Code)
  • Bugs
  • Meetings
  • Testing
  • Code Design
  • Jenkins
  • Ideas
  • Open Tasks
  • Patches
  • API Reference

• Build & Host
  • Building
  • IDEs
  • Hosting
• |
• Misc.
  • Third Party Projects

Stendhal Javadoc

The browsable javadoc is located at http://stendhalgame.org/jenkins/job/stendhal_HEAD/javadoc.

Finding your way around the Code

• Finding your way around the Stendhal Server Code.
• Finding your way around the Stendhal Client Code.

Coding Standards

The code is written to compile on Sun Java 1.5.

We try to follow SUN Java code convention.

Despite this:

• We use tab for all indentation. (One tab is equivalent to 4 spaces for display purpose.)
• We do not stick too closely to line length.

• We always use blocks in if-statements and loops, even if the block only consists of one single statement:

if (condition) {
    method();
}

Avoid evaluation and assignment in the same line like:

• ternary operators, for example in:

 String y = x==null ? "NULL": x.toString();

• post-increment/decrement operators as in:

 if (idx++ == 10) {
   ...
 }