mirror of
https://github.com/amyinspace/MagicSetEditor2.git
synced 2026-06-11 13:17:00 -04:00
Switched to a new coding style, which plays nicely with the Reader/Writer. This new style allows REFLECT to be used instead of REFLECT_N in most places.
git-svn-id: svn://svn.code.sf.net/p/magicseteditor/code/trunk@15 0fc631ac-6414-0410-93d0-97cfa31319b6
This commit is contained in:
@@ -0,0 +1,35 @@
|
||||
/** @page coding_conventions Coding conventions
|
||||
|
||||
MSE uses the following coding style:
|
||||
@code
|
||||
/// Doxygen documentation
|
||||
class ClassName {
|
||||
public:
|
||||
void someMemberFunction();
|
||||
private:
|
||||
int some_member; ///< postfix doxygen documentation
|
||||
};
|
||||
|
||||
void a_global_function();
|
||||
|
||||
enum MyEnumeration
|
||||
{ MY_SOMETHING
|
||||
, MY_SOMETHING_ELSE
|
||||
};
|
||||
@endcode
|
||||
|
||||
The rules are:
|
||||
- Classes use CaptializationForEachWord
|
||||
- Member functions use camelCase
|
||||
- Data members and globals use lower_case_with_underscores
|
||||
- Constants (enumeration values) and macros are UPPER_CASE_WITH_UNDERSCORES
|
||||
|
||||
The exceptions to this are:
|
||||
- wxWidgets functions, which LookLikeThis
|
||||
- wxWidget classes, which look like wxSomeClass
|
||||
- C++ standard library and boost, lower_case for everything
|
||||
- Person names, in particular deCasteljau
|
||||
- Class names in function names, in particular clearDC
|
||||
|
||||
|
||||
*/
|
||||
Reference in New Issue
Block a user