mcMMO/standards.md
NuclearW a542d6cf3e Squashed commit of the following:
commit cb3e057dee1f2b29838ab654a526baac1baab7d6
Author: NuclearW <incongruency@gmail.com>
Date:   Fri Mar 1 00:43:57 2013 -0500

    1.4.00 release

commit 4f9628d2e4cde31c8946e9a911ee6f10e1fb6b35
Author: NuclearW <incongruency@gmail.com>
Date:   Fri Mar 1 00:07:30 2013 -0500

    \r -> \n

commit b2ca22e0477c747143b0f08a28a096967ee6ffd7
Author: GJ <gjmcferrin@gmail.com>
Date:   Thu Feb 28 23:53:56 2013 -0500

    Commented-out code shouldn't be done like that.

commit 92f131712cc671e3e616c14a22e22769ef6d6d0b
Author: GJ <gjmcferrin@gmail.com>
Date:   Thu Feb 28 23:45:36 2013 -0500

    More things we missed.

commit 408b03766f6261a03a862a1ab7f5835772feda4a
Author: NuclearW <incongruency@gmail.com>
Date:   Thu Feb 28 23:20:13 2013 -0500

    Format: util through spout and backup lib

commit d6bd2c29bbb51bee3607247468cfe145d4f38c9e
Author: GJ <gjmcferrin@gmail.com>
Date:   Thu Feb 28 22:50:08 2013 -0500

    The things we missed the first time through...

commit 393f0b889aa1b7011ee81ee7b15413d8824b8cfb
Author: GJ <gjmcferrin@gmail.com>
Date:   Thu Feb 28 22:05:29 2013 -0500

    Formatting: Skills

commit c097a6e188a7b760dd1b4389ed81dca417146b16
Author: GJ <gjmcferrin@gmail.com>
Date:   Thu Feb 28 19:30:12 2013 -0500

    Organize imports.

commit 34c3e74be7eb5f983f21d969e30155c5d82c01c1
Author: GJ <gjmcferrin@gmail.com>
Date:   Thu Feb 28 19:09:45 2013 -0500

    Fixed a missing fallthrough comment from ChatCommand

commit b4a76c9f022a2fd98bdd8f083accfea03becfd71
Author: GJ <gjmcferrin@gmail.com>
Date:   Thu Feb 28 19:09:36 2013 -0500

    Formatting: datatypes.* through events.*

commit 3e57dd41d3265a7c8106c7eb026df926770a4d15
Author: NuclearW <incongruency@gmail.com>
Date:   Thu Feb 28 17:56:15 2013 -0500

    Fix issue with bad rebase

commit e8c8e06b2971555b7334e49128257e3af6f36892
Author: GJ <gjmcferrin@gmail.com>
Date:   Thu Feb 28 17:35:32 2013 -0500

    Formatting: DatabaseManager, LeaderboardManager, DatabaseUpdateType, and
    PlayerStat

commit 13ecf1cc41f377a12991e357ac10abdcda24d6de
Author: NuclearW <incongruency@gmail.com>
Date:   Thu Feb 28 17:31:43 2013 -0500

    Format: listeners.* through runnables.*

commit 71686e3c0d96c2dcf25442b91703fadda1ea3bb0
Author: NuclearW <incongruency@gmail.com>
Date:   Thu Feb 28 17:13:57 2013 -0500

    Format PartyLockCommand

commit d50abed10bf94e1a88df3dc5cc07c259aea920ea
Author: NuclearW <incongruency@gmail.com>
Date:   Thu Feb 28 16:54:08 2013 -0500

    Format: base through config.*

commit 7004823eeebbae5be7728bf9cafc3b04e57b64cf
Author: NuclearW <incongruency@gmail.com>
Date:   Thu Feb 28 15:21:40 2013 -0500

    Example of using spaces to align like things

commit 534190cfe2481e466fe459d65628550458cc2993
Author: NuclearW <incongruency@gmail.com>
Date:   Thu Feb 28 15:12:19 2013 -0500

    Capitalization

commit 5b61d3ba4c8d81e6f358b0cf4f460abfe9798414
Author: NuclearW <incongruency@gmail.com>
Date:   Thu Feb 28 15:07:43 2013 -0500

    Updated readme, added standards.md

commit 5ec0df70fb82c527420a2f437f27f31bd758f884
Author: NuclearW <incongruency@gmail.com>
Date:   Thu Feb 28 14:42:16 2013 -0500

    Markdown was here, Creole is a loser

commit 70d557c59d086b6a5fb5e0e63c0c1d8eb4c8d19c
Author: NuclearW <incongruency@gmail.com>
Date:   Thu Feb 28 13:46:24 2013 -0500

    Move MCStats shading to .metrics.mcstats

commit eb9d67e66b1659d6abd2397ecf403343cfeffdda
Author: GJ <gjmcferrin@gmail.com>
Date:   Thu Feb 28 13:37:37 2013 -0500

    Move ALL the packages!

commit 8ffa9e7b75417b6c7f158613d4b4ffb783dcf2d0
Author: NuclearW <incongruency@gmail.com>
Date:   Thu Feb 28 12:37:12 2013 -0500

    /r/n -> /n
2013-03-01 00:52:01 -05:00

3.0 KiB

  • git enforced \n line endings
  • 4-spaces instead of tabs for indentation
  • Spaces after control statements before beginning parenthesis or brace
  • if (
  • for (
  • while (
  • do {
  • try {
  • public class SomeClass {
  • Spaces after closing parenthesis in a control statement
  • No newline after closing parenthesis and space in a control statement:
  • if () {
  • for () {
  • while () {
  • catch () {
  • switch () {
  • Newlines before an else, else if, catch, and finally statement
  • }
    

else {

  • }
    

else if () {

  • }
    

catch () {

  • }
    

finally () {

  • Space after ; in for statement, not before
  • for (int i = 0; i < 10; i++) {
  • Spaces around operators
  • a + b
  • a == b
  • for (Type blah : blahs) {
  • "String " + "concatenation"
  • Spaces around { and } on one-line declarations
  • public boolean aMethod() { return something; }
  • Fewer extraneous parentheses, except when they increase readability
  • if (a == b || b == c)
  • Indent on case in switch case statements
  • switch () {
             case 1:
  • Mandatory comment for when a case falls through, and when not stacking
  • switch () {
             case 1:
                 // Fallthrough
    
             case 2:
  • switch () {
             case 1:
             case 2:
             case 3:
             case 4:
             case 5:
                 // Fallthrough
    
             case 6:
  • Empty line between cases after break, return, or fallthrough
  • switch () {
             case 1:
                 break;
    
             case 2:
  • Whenever possible, check for a negative, rather than a positive
  • if (!something) {
             // Do things
         }
    
         // Do other things
  • Java standard class and method naming, with exception to McMMO in a class name
  • thisIsAMethod()
  • ThisIsAClass
  • Exception:
McMMOCustomClass
  • No space before opening parenthesis for methods, or constructors
  • public void thisIsAMethod() {
  • public ThisIsAClass() {
  • Spaces after comma in method calls and constructors, not before
  • something.methodCall(variable, otherVariable);
  • Accessing of variables with this. only when necessary to resolve scope
  • Class variables always defined at the top, before the constructor
  • No empty line between class declaration and beginning of variable declaration
  • Always a empty line at the end of a method or constructor definition
  • Constructors come before methods, and are typically ordered from the ones with the least arguments to the most
  • Methods should be ordered in this manner:
  • override public
  • public
  • static public
  • abstract public
  • override protected
  • protected
  • static protected
  • abstract protected
  • override private
  • private
  • static private
  • abstract private
  • No one-line if statements, they should all have brackets