X-Git-Url: http://gitweb.pgornicz.com/gitweb.cgi?a=blobdiff_plain;f=src%2Fcodingstyle.txt;h=b2fda272eadfdaa571aaaf87fc74764dab91deaf;hb=617dcc71d9a71663f63fb56ffac2505b45bf91b9;hp=f1da7768089e7b7e2162457dcbb84d4917fc2e0d;hpb=7adc59fef43ae9741d455448770b585e28e87c98;p=physics.git diff --git a/src/codingstyle.txt b/src/codingstyle.txt index f1da776..b2fda27 100644 --- a/src/codingstyle.txt +++ b/src/codingstyle.txt @@ -18,20 +18,24 @@ This is in a very short form as it's mostly for myself. - sections of a file should be commented with the following where appropriate - they should appear in this order - - they should have two newlines before star lines, excluding the first + - they should have a newline above and below star lines +Headers: +/// ***** Header Class ***** +/// ***** Header Methods ***** + +Source: /// ***** Private Method Headers ***** /// ***** Private Variables ***** -/// ***** Constructors/Destructors ***** +/// ***** MAIN Method ***** -/// ***** Public Methods ***** -/// ***** Private Methods ***** +/// ***** Constructors/Destructors ***** +/// ***** Initializers/Cleaners ***** /// ***** Public Class Methods ***** /// ***** Protected Class Methods ***** /// ***** Private Class Methods ***** - -/// ***** Header Class ***** -/// ***** Header Methods ***** +/// ***** Public Methods ***** +/// ***** Private Methods *****