Android 코드 규범 코드 스타일

18874 단어 android
/*

 *    (  ),  CodingRuler.java

 * 

 *     (  ), :@version 1.0.0

 * 

 *     (           ), :Copyright (C) 2010-2013 SINA Corporation.

 */



package com.xxx.codestyle;



/**

 *           。

 * 

 * <p>

 * <b>NOTE:              ,        ORACLE     。</b><br>

 *   :http://www.oracle.com/technetwork/java/codeconventions-150003.pdf<br>

 *   ,    UTF-8        ,        。<br>

 * <b>              ,      ,            ,      。</b><br>

 * </p>

 * <h3>1.     </h3>

 * <ul>

 *    <li>1.1. Java            ,          @SuppressWarnings。

 *    <li>1.2.       、  、   ,      。

 *    <li>1.3.    Lint              。

 *    <li>1.4.    Ctrl+Shift+F       ,       。

 *    <li>1.5.    Ctrl+Shift+O      Import  。

 * </ul>

 * 

 * <h3>2.     </h3>

 *    <h3>2.1.     </h3>

 *    <ul>

 *         <li>2.1.1.   ,  ,      ,       name1, name2    。

 *         <li>2.1.2.       ,         。(       25    )

 *         <li>2.1.3.           ,           。

 *         <li>2.1.4.                     。

 *         <li>2.1.5.       ,    2    to,  4    for  ,  go2Clean。

 *     </ul>

 *    

 *    <h3>2.2.  、  </h3>

 *    <ul>

 *         <li>2.2.1.           。         、    、     。      。

 *         <li>2.2.2.     I   , able, ible, er   。 ISeriable。

 *    </ul>

 *    

 *    <h3>2.3.   、  </h3>

 *    <ul>

 *         <li>2.3.1.       m   ,      s   ,  mUserName, sInstance。

 *         <li>2.3.2.       ,            ,  MAX_NUMBER。

 *         <li>2.3.3.           ,               。

 *         <li>2.3.4.          ,       ,     @Deprecated,  {@link #doSomething()}

 *    </ul>

 *         

 * <h3>3.   </h3>

 *        {@link #SampleCode}     。

 *    <ul>

 *    <li>3.1.     ,   {@link #ACTION_MAIN} 

 *    <li>3.2.     ,   {@link #mObject0} 

 *    <li>3.3.     ,   {@link #doSomething(int, float, String)}

 *    </ul> 

 *    

 * <h3>4. Class        </h3>

 * <ul>

 *    <li>4.1.    class                     、  、    ,

 *                       。

 *    <li>4.2.      ,     public,   protected,    private,      

 *                          ,    。

 *    <li>4.3.         :<br>

 *           TAG,    private(  )<br>

 *            public   <br>

 *            protected   、   <br>

 *            private   <br>

 *            public   <br>

 *            protected   <br>

 *            private   <br>

 * </ul>        

 * 

 * <h3>5.       </h3>

 *    <h3>5.1.     :            </h3>

 *    <h3>5.2.   </h3>

 *    <ul>

 *         <li>5.2.1.      ,   {@link #conditionFun(boolean)} 

 *         <li>5.2.2. switch   ,   {@link #switchFun(int)}

 *         <li>5.2.3.     ,   {@link #circulationFun(boolean)}

 *         <li>5.2.4.      ,   {@link #exceptionFun()}

 *         <li>5.2.5.   ,   {@link #otherFun()}

 *         <li>5.2.6.   ,   {@link #doSomething(int, float, String)}

 *     </ul>

 * 

 * @author    

 * @since 2013-XX-XX

 */

@SuppressWarnings("unused")

public class CodingRuler {



    /**         */

    public static final String ACTION_MAIN = "android.intent.action.MAIN";

    

    /**        (               ) */

    private static final int MSG_AUTH_NONE    = 0;

    private static final int MSG_AUTH_SUCCESS = 1;

    private static final int MSG_AUTH_FAILED  = 2;

    

    /**           */

    protected Object mObject0;

    

    /**         mObject1   (                 ) */

    private Object mObject1;

    /**         mObject2    */

    private Object mObject2;

    /**         mObject3    */

    private Object mObject3;

    

    /**

     *          ,       

     *      

     */

    private Object mObject4;



    /**

     *       ...

     * 

     * @param param1    1  ...

     * @param param2    2  ...

     * @param paramXX   XX  ... (  :    、     )

     */

    public void doSomething(int param1, float param2, String paramXX) {

        //           Eclipse   Task    

        // TODO    TODO     ,             

        // FIXME   FIXME     ,           ,     

        //          ,    ,    

        // XXX     XXX     ,              ,    

        //

    }

    

    /**

     *       ...

     */

    @Deprecated

    protected void doSomething() {

        // ...implementation

    }

    

    /**

     *       ...

     * 

     * @param param1    1  ...

     * @param param2    2  ...

     */

    private void doSomethingInternal(int param1, float param2) {

        // ...implementation        

    }

    

    /**

     *        。

     */

    private void conditionFun() {

        boolean condition1 = true;

        boolean condition2 = false;

        boolean condition3 = false;

        boolean condition4 = false;

        boolean condition5 = false;

        boolean condition6 = false;

        

        //   : 1.    if       {}     ,      ,      {}   

        //       2.              ,                

        //       3.        ,        

        if (condition1) {

            // ...implementation

        }

        

        if (condition1) {

            // ...implementation

        } else {

            // ...implementation

        }

        

        if (condition1)          /*       {}    */

            condition3 = true;

        

        if ((condition1 == condition2) 

                || (condition3 == condition4)

                || (condition5 == condition6)) {

            

        }

    }

    

    /**

     * Switch    。

     */

    private void switchFun() {

        

        //   : 1. switch    ,break      case   ,   

        //       2.       break    ,    /* Falls through */   

        //       3.       default   ,     

        int code = MSG_AUTH_SUCCESS;

        switch (code) {

        case MSG_AUTH_SUCCESS:

            break;

            

        case MSG_AUTH_FAILED:

            break;

            

        case MSG_AUTH_NONE:

            /* Falls through */

        default:

            break;

        }

    }

    

    /**

     *      。

     */

    private void circulationFun() {

        

        //   : 1.     for each       for  

        //       2.                 ,     

        //       3.         ,               

        //       4.         3 ,         

        

        int array[] = { 1, 2, 3, 4, 5 };

        for (int data : array) {

            // ...implementation

        }

        

        int length = array.length;

        for (int ix = 0; ix < length; ix++) {

            // ...implementation

        }

        

        boolean condition = true;

        while (condition) {

            // ...implementation

        }

        

        do {

            // ...implementation

        } while (condition);

    }

    

    /**

     *       。

     */

    private void exceptionFun() {

        

        //   : 1.           ,     catch        。

        //       2.        ,     finally      。    Cursor  。

        try {

            // ...implementation

        } catch (Exception e) {

            e.printStackTrace();

        } finally {

            

        }

    }

    

    /**

     *     (   ...)。

     */

    private void otherFun() {

        // TODO

    }    

}

좋은 웹페이지 즐겨찾기