From d50e5d43099c874500fcd98e3b08d20ec8d7ae07 Mon Sep 17 00:00:00 2001 From: Carlos Daniel Ruvalcaba Valenzuela Date: Sun, 2 Sep 2007 18:00:01 -0700 Subject: [PATCH] Update Code Style Guidelines --- README.mob | 14 -------------- docs/codingstyle.txt | 44 ++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 44 insertions(+), 14 deletions(-) delete mode 100644 README.mob diff --git a/README.mob b/README.mob deleted file mode 100644 index 8e7610c..0000000 --- a/README.mob +++ /dev/null @@ -1,14 +0,0 @@ -This is the MOB branch of FMail, you may push -your changes to it freely, you don't need password -or anything, however beware that anybody can push -here, here some tips: - -* Check the code well before compiling or running, - you may want to run gitk to check changes from - master branch. -* Respect others code, you should just push trash - here, otherwise others won't push here their code - and we'll get less contributions :( - -Anyways, have fun! We check the mob branch to se if -there is something interesting from time to time! diff --git a/docs/codingstyle.txt b/docs/codingstyle.txt index 15c0a49..10a65e4 100644 --- a/docs/codingstyle.txt +++ b/docs/codingstyle.txt @@ -1,4 +1,48 @@ +Classes + +Class names should be UpperCase + +Reason: + +Examples + +Good: + +class SocketIPC{ + +Bad + +class socketipc{ + + +Class function names should be UpperCase, except +when using any of the following prefixes, in which +case they whould be in cammelCase: + +* is - isAlive +* get - getValue +* set - setValue +* has - hasKey + +Reason: + +Code readability. + +Examples + +Good: + +int getValue(); +int Height(); + +Bad: + +int GetValue(); +int height(); + + + Spaces -- 2.11.4.GIT