diff --git a/README.md b/README.md index 9ad7c0e..24cdce4 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ Java Code Styles ================ -IntelliJ IDEA code style settings for Square's Java and Android projects. +IntelliJ IDEA code style settings for seong-il's Java and Android projects. Installation @@ -13,6 +13,56 @@ Installation project to the one you want. +## Important Code Arrangement. + +Class and Interface files must contain the below comments. +All members including variables, methods, listeners, etc.. should align as per the comments. + +### Class + + // ======================================================================== + // constants + // ======================================================================== + + // ======================================================================== + // fields + // ======================================================================== + + // ======================================================================== + // constructors + // ======================================================================== + + // ======================================================================== + // getter & setter + // ======================================================================== + + // ======================================================================== + // methods for/from superclass/interfaces + // ======================================================================== + + // ======================================================================== + // methods + // ======================================================================== + + // ======================================================================== + // inner and anonymous classes + // ======================================================================== + + +### Interface + // ======================================================================== + // constants + // ======================================================================== + + // ======================================================================== + // methods + // ======================================================================== + + + + + + License ------- diff --git a/configs/codestyles/Square.xml b/configs/codestyles/seong-il.xml similarity index 89% rename from configs/codestyles/Square.xml rename to configs/codestyles/seong-il.xml index 0d5bd27..39c6065 100644 --- a/configs/codestyles/Square.xml +++ b/configs/codestyles/seong-il.xml @@ -1,4 +1,4 @@ - +