I suggest you to check this section frequently because it can change as the development goes on...
GENERAL
Every header file should contain at the beginning:
Code: Select all
// The Mana World (C) 2004
COMMENTS
Every function should be preceded by:
Code: Select all
/** What this function does */
Code: Select all
// comment
DIR TREE
-The Mana World
|->Gui
|-->Skin
|->Graphic
|->Net
|->Maps
|->Sound
|-->BGM
|-->Samples
Well the names should be self-explanatory. The showed dir tree should be used for code but also for essential files such as bitmaps, mp3s, ecc..
FILE NAMES
File names as for every good program should have useful names.
GUI FILES:
*_dialog.h/.cpp (Where * stands for the function of the dialog: chat_dialog, new_char_dialog, ecc...)
BEINGS/ITEMS FILES:
npc.h/.cpp, item.h/.cpp, card.h/.cpp, ecc...
MODIFICATIONS TO CODE
When someone modifies other people's code they should add this lines:
Code: Select all
// "Author" "Version" "Date"
// "Description"
Modified code
// END
Code: Select all
// Elven Programmer v1.0 5/6/04
// I modified this code because I didn't like it! ihihih
...
// END