Android开发规范

OdetteRidde 7年前
   <h2>安卓开发规范(updating)</h2>    <h2>摘要</h2>    <h3>前言</h3>    <p>为了利于项目维护以及规范开发,促进成员之间Code Review的效率,故提出以下开发规范。</p>    <h3>AS规范</h3>    <p>工欲善其事,必先利其器。</p>    <ol>     <li>尽量使用最新版的IDE进行开发;</li>     <li>编码格式统一为 <strong>UTF-8</strong> ;</li>     <li>编辑完.java、.xml等文件后一定要 <strong>格式化</strong> (缩进对齐与AS默认一致即可);</li>     <li>删除多余的import,减少警告出现,可利用AS的 Optimize Imports 快捷键;</li>     <li>AS常用开发插件可以参考这里~AS常用开发插件</li>    </ol>    <h3>命名规范</h3>    <p>1. 包名</p>    <p>包名全部小写,连续的单词只是简单地连接起来,不使用下划线。</p>    <p>采用反域名命名规则,全部使用小写字母。一级包名是顶级域名,通常为com, edu, gov, net, org等,二级包名为公司名,三级包名根据应用进行命名,四级包名为模块名或层级名。</p>    <table>     <thead>      <tr>       <th>包名</th>       <th>此包中包含</th>      </tr>     </thead>     <tbody>      <tr>       <td>com.xx.应用名称缩写.activity</td>       <td>用户界面中所有的Activity类</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.fragment</td>       <td>界面中所有的Fragment类</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.base</td>       <td>基础共享的类</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.adapter</td>       <td>页面用到的Adapter类 (适配器的类)</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.view</td>       <td>自定义的View类</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.util</td>       <td>此包中包含:公共工具方法类(util模块名)</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.bean</td>       <td>下面可分:vo、po、dto 此包中包含:JavaBean类</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.model</td>       <td>此包中包含:模型类</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.db</td>       <td>数据库操作类</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.view (或者 com.xx.应用名称缩写.widget )</td>       <td>自定义的View类等</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.service</td>       <td>Service服务</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.receiver</td>       <td>BroadcastReceiver服务</td>      </tr>      <tr>       <td>com.xx.应用名称缩写.confing</td>       <td>所有的配置相关的类</td>      </tr>     </tbody>    </table>    <p>注意:如果项目采用MVP,所有M、V、P抽取出来的接口都放置在相应模块的i包下,所有的实现都放置在相应模块的impl下</p>    <p>2. 类名</p>    <p>类名都以 UpperCamelCase 风格编写。</p>    <p>类名通常是名词或名词短语,接口名称有时可能是形容词或形容词短语。现在还没有特定的规则或行之有效的约定来命名注解类型。</p>    <p>名词,采用大驼峰命名法,尽量避免缩写,除非该缩写是众所周知的, 比如HTML,URL,如果类名称中包含单词缩写,则单词缩写的每个字母均应大写。</p>    <table>     <thead>      <tr>       <th>类</th>       <th>描述</th>       <th>例如</th>      </tr>     </thead>     <tbody>      <tr>       <td>Activity 类</td>       <td>Activity为后缀标识</td>       <td>欢迎页面类WelcomeActivity</td>      </tr>      <tr>       <td>Adapter类</td>       <td>Adapter 为后缀标识</td>       <td>新闻详情适配器 NewDetailAdapter</td>      </tr>      <tr>       <td>解析类</td>       <td>Parser为后缀标识</td>       <td>首页解析类HomePosterParser</td>      </tr>      <tr>       <td>工具方法类</td>       <td>Utils或Manager为后缀标识(与系统或第三方的Utils区分)或功能+Utils</td>       <td>线程池管理类:ThreadPoolManager日志工具类:LogUtils(Logger也可)打印工具类:PrinterUtils</td>      </tr>      <tr>       <td>数据库类</td>       <td>以DBHelper后缀标识</td>       <td>新闻数据库:NewDBHelper</td>      </tr>      <tr>       <td>Service类</td>       <td>以Service为后缀标识</td>       <td>时间服务TimeServiceBroadcast</td>      </tr>      <tr>       <td>Receiver类</td>       <td>以Receiver为后缀标识</td>       <td>推送接收JPushReceiver</td>      </tr>      <tr>       <td>ContentProvider</td>       <td>以Provider为后缀标识</td>       <td> </td>      </tr>      <tr>       <td>自定义的共享基础类</td>       <td>以Base开头</td>       <td>BaseActivity,BaseFragment</td>      </tr>     </tbody>    </table>    <p>测试类的命名以它要测试的类的名称开始,以Test结束。例如:HashTest 或 HashIntegrationTest。</p>    <p>接口(interface):命名规则与类一样采用大驼峰命名法,多以able或ible结尾,如</p>    <p>interface Runnable , interface Accessible。</p>    <p>注意:如果项目采用MVP,所有Model、View、Presenter的接口都以I为前缀,不加后缀,其他的接口采用上述命名规则。</p>    <p>3. 方法名</p>    <p>方法名都以 lowerCamelCase 风格编写。</p>    <p>方法名通常是动词或动词短语。</p>    <table>     <thead>      <tr>       <th>方法</th>       <th>说明</th>      </tr>     </thead>     <tbody>      <tr>       <td>initXX()</td>       <td>初始化相关方法,使用init为前缀标识,如初始化布局initView()</td>      </tr>      <tr>       <td>isXX() checkXX()</td>       <td>方法返回值为boolean型的请使用is或check为前缀标识</td>      </tr>      <tr>       <td>getXX()</td>       <td>返回某个值的方法,使用get为前缀标识</td>      </tr>      <tr>       <td>setXX()</td>       <td>设置某个属性值</td>      </tr>      <tr>       <td>handleXX()/processXX()</td>       <td>对数据进行处理的方法</td>      </tr>      <tr>       <td>displayXX()/showXX()</td>       <td>弹出提示框和提示信息,使用display/show为前缀标识</td>      </tr>      <tr>       <td>updateXX()</td>       <td>更新数据</td>      </tr>      <tr>       <td>saveXX()</td>       <td>保存数据</td>      </tr>      <tr>       <td>resetXX()</td>       <td>重置数据</td>      </tr>      <tr>       <td>clearXX()</td>       <td>清除数据</td>      </tr>      <tr>       <td>removeXX()</td>       <td>移除数据或者视图等,如removeView();</td>      </tr>      <tr>       <td>drawXXX()</td>       <td>绘制数据或效果相关的,使用draw前缀标识</td>      </tr>     </tbody>    </table>    <p>4. 常量名</p>    <p>常量名命名模式为 CONSTANT_CASE ,全部字母大写,用下划线分隔单词。那,到底什么算是一个常量?</p>    <p>每个常量都是一个静态final字段,但不是所有静态final字段都是常量。在决定一个字段是否是一个常量时,考虑它是否真的感觉像是一个常量。例如,如果任何一个该实例的观测状态是可变的,则它几乎肯定不会是一个常量。只是永远不打算改变对象一般是不够的,它要真的一直不变才能将它示为常量。</p>    <pre>  // Constants  static final int NUMBER = 5;  static final ImmutableListNAMES = ImmutableList.of("Ed", "Ann");  static final Joiner COMMA_JOINER = Joiner.on(','); // because Joiner is immutable  static final SomeMutableType[] EMPTY_ARRAY = {};  enum SomeEnum { ENUM_CONSTANT }  // Not constants  static String nonFinal = "non-final";  final String nonStatic = "non-static";  static final SetmutableCollection = new HashSet();  static final ImmutableSetmutableElements = ImmutableSet.of(mutable);  static final Logger logger = Logger.getLogger(MyClass.getName());  static final String[] nonEmptyArray = {"these", "can", "change"};</pre>    <p>5. 非常量字段名</p>    <p>非常量字段名以 lowerCamelCase 风格的基础上改造为如下风格:基本结构为 scopeVariableNameType 。</p>    <p>scope:范围</p>    <p>非公有,非静态字段命名以m开头。</p>    <p>静态字段命名以s开头。</p>    <p>公有非静态字段命名以p开头。</p>    <p>公有静态字段(全局变量)命名以g开头。</p>    <p>例子:</p>    <pre>  public class MyClass {        int mPackagePrivate;          private int mPrivate;          protected int mProtected;        private static MyClass sSingleton;          public int pField;        public static int gField;  }</pre>    <p>使用1字符前缀来表示作用范围,1个字符的前缀必须小写,前缀后面是由表意性强的一个单词或多个单词组成的名字,而且每个单词的首写字母大写,其它字母小写,这样保证了对变量名能够进行正确的断句。</p>    <p>Type:类型</p>    <p>考虑到Android中使用很多UI控件,为避免控件和普通成员变量混淆以及更好达意,所有用来表示控件的成员变量统一加上控件缩写作为后缀(文末附有缩写表)。</p>    <p>对于普通变量一般不添加类型后缀,如果统一添加类型后缀,请参考文末的缩写表。</p>    <p>用统一的量词通过在结尾处放置一个量词,就可创建更加统一的变量,它们更容易理解,也更容易搜索。</p>    <p>注意:如果项目中使用ButterKnife,则不添加m前缀,以lowerCamelCase风格命名。</p>    <p>例如,请使用 mCustomerStrFirst 和 mCustomerStrLast,而不要使用mFirstCustomerStr和mLastCustomerStr。</p>    <table>     <thead>      <tr>       <th>量词列表</th>       <th>量词后缀说明</th>      </tr>     </thead>     <tbody>      <tr>       <td>First</td>       <td>一组变量中的第一个</td>      </tr>      <tr>       <td>Last</td>       <td>一组变量中的最后一个</td>      </tr>      <tr>       <td>Next</td>       <td>一组变量中的下一个变量</td>      </tr>      <tr>       <td>Prev</td>       <td>一组变量中的上一个</td>      </tr>      <tr>       <td>Cur</td>       <td>一组变量中的当前变量</td>      </tr>     </tbody>    </table>    <p>说明:</p>    <p>集合添加如下后缀:List、Map、Set</p>    <p>数组添加如下后缀:Arr</p>    <p>注意:所有的VO(值对象)统一采用标准的lowerCamelCase风格编写,所有的DTO(数据传输对象)就按照接口文档中定义的字段名编写。</p>    <p>6. 参数名</p>    <p>参数名以 lowerCamelCase 风格编写。</p>    <p>参数应该避免用单个字符命名。</p>    <p>7. 局部变量名</p>    <p>局部变量名以 lowerCamelCase 风格编写,比起其它类型的名称,局部变量名可以有更为宽松的缩写。</p>    <p>虽然缩写更宽松,但还是要避免用单字符进行命名,除了临时变量和循环变量。</p>    <p>即使局部变量是final和不可改变的,也不应该把它示为常量,自然也不能用常量的规则去命名它。</p>    <p>8. 临时变量</p>    <p>临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型。 如: for (int i = 0; i < len ; i++)。</p>    <p>9. 类型变量名</p>    <p>类型变量可用以下两种风格之一进行命名:</p>    <p>单个的大写字母,后面可以跟一个数字(如:E, T, X, T2)。</p>    <p>以类命名方式(参考2. 类名),后面加个大写的T(如:RequestT, FooBarT)。</p>    <h3>资源文件规范</h3>    <p>1. 资源布局文件(XML文件(layout布局文件))</p>    <p>全部小写,采用下划线命名法</p>    <p>1) contentview 命名</p>    <p>必须以全部单词小写,单词间以下划线分割,使用名词或名词词组。</p>    <p>所有Activity或Fragment的contentView必须与其类名对应,对应规则为:</p>    <p>将所有字母都转为小写,将类型和功能调换(也就是后缀变前缀)。</p>    <p>例如: activity_main.xml</p>    <p>2) Dialog命名: dialog_描述.xml</p>    <p>例如: dialog_hint.xml</p>    <p>3) PopupWindow命名: ppw_描述.xml</p>    <p>例如: ppw_info.xml</p>    <p>4) 列表项命名: item_描述.xml</p>    <p>例如: item_city.xml</p>    <p>5) 包含项命名: 模块_(位置)描述.xml</p>    <p>例如: activity_main_head.xml 、 activity_main_bottom.xml</p>    <p>注意:通用的包含项命名采用: 项目名称缩写_描述.xml</p>    <p>例如: xxxx_title.xml</p>    <p>2. 资源文件(图片drawable文件夹下)</p>    <p>全部小写,采用下划线命名法,加前缀区分</p>    <p>命名模式:可加后缀 _small 表示小图, _big 表示大图,逻辑名称可由多个单词加下划线组成,采用以下规则:</p>    <p>用途_模块名_逻辑名称<br> 用途_模块名_颜色<br> 用途_逻辑名称<br> 用途_颜色</p>    <p>说明:用途也指控件类型(具体见UI控件缩写表)</p>    <p>例如:</p>    <p>btn_main_home.png 按键</p>    <p>divider_maket_white.png 分割线</p>    <p>ic_edit.png 图标</p>    <p>bg_main.png 背景</p>    <p>btn_red.png 红色按键</p>    <p>btn_red_big.png 红色大按键</p>    <p>ic_head_small.png 小头像</p>    <p>bg_input.png 输入框背景</p>    <p>divider_white.png 白色分割线</p>    <p>如果有多种形态如按钮等除外如 btn_xx.xml (selector)</p>    <table>     <thead>      <tr>       <th>名称</th>       <th>功能</th>      </tr>     </thead>     <tbody>      <tr>       <td>btn_xx</td>       <td>按钮图片使用 btn_整体效果 (selector)</td>      </tr>      <tr>       <td>btn_xx_normal</td>       <td>按钮图片使用 btn_正常情况效果</td>      </tr>      <tr>       <td>btn_xx_pressed</td>       <td>按钮图片使用 btn_点击时候效果</td>      </tr>      <tr>       <td>btn_xx_focused</td>       <td>state_focused 聚焦效果</td>      </tr>      <tr>       <td>btn_xx_disabled</td>       <td>state_enabled (false)不可用效果</td>      </tr>      <tr>       <td>btn_xx_checked</td>       <td>state_checked 选中效果</td>      </tr>      <tr>       <td>btn_xx_selected</td>       <td>state_selected 选中效果</td>      </tr>      <tr>       <td>btn_xx_hovered</td>       <td>state_hovered 悬停效果</td>      </tr>      <tr>       <td>btn_xx_checkable</td>       <td>state_checkable 可选效果</td>      </tr>      <tr>       <td>btn_xx_activated</td>       <td>state_activated 激活的</td>      </tr>      <tr>       <td>btn_xx_windowfocused</td>       <td>state_window_focused</td>      </tr>      <tr>       <td>bg_head</td>       <td>背景图片使用 bg_功能_说明</td>      </tr>      <tr>       <td>def_search_cell</td>       <td>默认图片使用 def_功能_说明</td>      </tr>      <tr>       <td>ic_more_help</td>       <td>图标图片使用 ic_功能_说明</td>      </tr>      <tr>       <td>seg_list_line</td>       <td>具有分隔特征的图片使用 seg_功能_说明</td>      </tr>      <tr>       <td>sel_ok</td>       <td>选择图标使用 sel_功能_说明</td>      </tr>     </tbody>    </table>    <p>注意:使用AndroidStudio的插件SelectorChapek可以快速生成selector,前提是命名要规范。</p>    <p>3. 动画文件(anim文件夹下)</p>    <p>全部小写,采用下划线命名法,加前缀区分。</p>    <p>具体动画采用以下规则:</p>    <p>模块名_逻辑名称</p>    <p>逻辑名称</p>    <p>refresh_progress.xml<br> market_cart_add.xml<br> market_cart_remove.xml</p>    <p>普通的tween动画采用如下表格中的命名方式</p>    <p>// 前面为动画的类型,后面为方向</p>    <table>     <thead>      <tr>       <th>动画命名例子</th>       <th>规范写法</th>      </tr>     </thead>     <tbody>      <tr>       <td>fade_in</td>       <td>淡入</td>      </tr>      <tr>       <td>fade_out</td>       <td>淡出</td>      </tr>      <tr>       <td>push_down_in</td>       <td>从下方推入</td>      </tr>      <tr>       <td>push_down_out</td>       <td>从下方推出</td>      </tr>      <tr>       <td>push_left</td>       <td>推向左方</td>      </tr>      <tr>       <td>slide_in_from_top</td>       <td>从头部滑动进入</td>      </tr>      <tr>       <td>zoom_enter</td>       <td>变形进入</td>      </tr>      <tr>       <td>slide_in</td>       <td>滑动进入</td>      </tr>      <tr>       <td>shrink_to_middle</td>       <td>中间缩小</td>      </tr>     </tbody>    </table>    <p>4. values中name命名</p>    <p>1) colors.xml</p>    <p>colors的name命名使用下划线命名法,在你的 colors.xml 文件中应该只是映射颜色的名称一个ARGB值,而没有其它的。不要使用它为不同的按钮来定义ARGB值。</p>    <p>不要这样做</p>    <pre>  <resources>        <color name="button_foreground">#FFFFFF</color>        <color name="button_background">#2A91BD</color>        <color name="comment_background_inactive">#5F5F5F</color>        <color name="comment_background_active">#939393</color>        <color name="comment_foreground">#FFFFFF</color>        <color name="comment_foreground_important">#FF9D2F</color>        ...        <color name="comment_shadow">#323232</color></pre>    <p>使用这种格式,你会非常容易的开始重复定义RGBA值,这使如果需要改变基本色变的很复杂。同时,这些定义是跟一些环境关联起来的,如 button 或者 comment , 应该放到一个按钮风格中,而不是在 color.xml 文件中。</p>    <p>相反,这样做:</p>    <pre>  <resources>          <!-- grayscale -->        <color name="white"     >#FFFFFF</color>        <color name="gray_light">#DBDBDB</color>        <color name="gray"      >#939393</color>        <color name="gray_dark" >#5F5F5F</color>        <color name="black"     >#323232</color>          <!-- basic colors -->        <color name="green">#27D34D</color>        <color name="blue">#2A91BD</color>        <color name="orange">#FF9D2F</color>        <color name="red">#FF432F</color>      </resources></pre>    <p>向应用设计者那里要这个调色板,名称不需要跟"green", "blue", 等等相同。 "brand_primary", "brand_secondary", "brand_negative" 这样的名字也是完全可以接受的。 像这样规范的颜色很容易修改或重构,会使应用一共使用了多少种不同的颜色变得非常清晰。 通常一个具有审美价值的UI来说,减少使用颜色的种类是非常重要的。</p>    <p>2) dimens.xml</p>    <p>像对待colors.xml一样对待dimens.xml文件 与定义颜色调色板一样,你同时也应该定义一个空隙间隔和字体大小的“调色板”。 一个好的例子,如下所示:</p>    <pre>  <resources>        <!-- font sizes -->      <dimen name="font_larger">22sp</dimen>      <dimen name="font_large">18sp</dimen>      <dimen name="font_normal">15sp</dimen>      <dimen name="font_small">12sp</dimen>        <!-- typical spacing between two views -->      <dimen name="spacing_huge">40dp</dimen>      <dimen name="spacing_large">24dp</dimen>      <dimen name="spacing_normal">14dp</dimen>      <dimen name="spacing_small">10dp</dimen>      <dimen name="spacing_tiny">4dp</dimen>        <!-- typical sizes of views -->      <dimen name="button_height_tall">60dp</dimen>      <dimen name="button_height_normal">40dp</dimen>      <dimen name="button_height_short">32dp</dimen>    </resources></pre>    <p>布局时在写 margins 和 paddings 时,你应该使用spacing_xxxx尺寸格式来布局,而不是像对待String字符串一样直接写值。 这样写会非常有感觉,会使组织和改变风格或布局是非常容易。</p>    <p>3) strings.xml</p>    <p>strings的name命名使用下划线命名法,采用以下规则:模块名+逻辑名称</p>    <p>例如:</p>    <p>main_menu_about 主菜单按键文字</p>    <p>friend_title 好友模块标题栏</p>    <p>friend_dialog_del 好友删除提示</p>    <p>login_check_email 登录验证</p>    <p>dialog_title 弹出框标题</p>    <p>button_ok 确认键</p>    <p>loading 加载文字</p>    <p>4) styles.xml</p>    <p>几乎每个项目都需要适当的使用style文件,因为对于一个视图来说有一个重复的外观是很常见的,将所有的外观细节属性(colors, padding, font)放在style文件中。 在应用中对于大多数文本内容,最起码你应该有一个通用的style文件,例如:</p>    <pre>  <style name="ContentText">      <item name="android:textSize">@dimen/font_normal</item>      <item name="android:textColor">@color/basic_black</item>  </style></pre>    <p>应用到TextView 中:</p>    <pre>  <TextView      android:layout_width="wrap_content"      android:layout_height="wrap_content"      android:text="@string/price"      style="@style/ContentText"      /></pre>    <p>你或许需要为按钮控件做同样的事情,不要停止在那里。将一组相关的和重复 android:**** 的属性放到一个通用的style中。</p>    <p>将一个大的style文件分割成多个文件, 你可以有多个 styles.xml 文件。Android SDK支持其它文件, styles 这个文件名称并没有作用,起作用的是在文件 里xml的 <style> 标签。因此你可以有多个style文件 styles.xml , style_home.xml , style_item_details.xml , styles_forms.xml 。 不同于资源文件路径需要为系统构建起的有意义,在 res/values 目录下的文件可以任意命名。</p>    <p>5. layout中的id命名</p>    <p>命名模式为: view缩写_模块名_逻辑名 ,比如btn_main_search</p>    <p>使用 AndroidStudio 的插件 ButterKnife Zelezny,生成注解非常方便,或者也可以使用Android Code Generator插件。</p>    <h3>版本统一规范</h3>    <p>Android开发存在着众多版本的不同,比如compileSdkVersion、minSdkVersion、targetSdkVersion以及项目中依赖第三方库的版本,不同的module及不同的开发人员都有不同的版本,所以需要一个统一版本规范的文件。</p>    <h3>第三方库规范</h3>    <p>别再闭门造车了,用用最新最火的技术吧,安利一波~ Android 流行框架查速表 ,顺便带上自己的干货~ <a href="/misc/goto?guid=4959717427420775633" rel="nofollow,noindex">Android开发人员不得不收集的代码</a></p>    <p>希望team能用时下较新的技术,不建议自己造轮子或者使用停止维护的轮子,否则出了问题也提不了issue。</p>    <p>个人推荐team使用Retrofit, RxAndroid, OkHttp, Glide/Fresco, Gson/Fastjson, EventBus/AndroidEventBus, GreenDao,(Dagger2, Tinker)。</p>    <h3>注释规范</h3>    <p>为了让他人可以容易看懂你的代码,请在关键地方做好注释。</p>    <p>1. 类注释</p>    <p>每个类完成后应该有作者姓名和联系方式的注释,对自己的代码负责。</p>    <pre>  /**   * <pre>   *     author : Blankj   *     e-mail : xxx@xx   *     time   : 2017/03/07   *     desc   : xxxx描述   *     version: 1.0   * </pre>   */</pre>    <p>具体可以在AS中自己配制,Setting → Editor → File and Code Templates → Includes → File Header,输入</p>    <pre>  /**   * <pre>   *     author : ${USER}   *     e-mail : xxx@xx   *     time   : ${YEAR}/${MONTH}/${DAY}   *     desc   : xxxx描述   *     version: 1.0   * </pre>   */  public class WelcomeActivity {         ...  }</pre>    <p>这样便可在每次新建类的时候自动加上该注释。</p>    <p>2. 方法注释</p>    <p>每一个成员方法(包括自定义成员方法、覆盖方法、属性方法)的方法头都必须做方法头注释,在方法前一行输入/**回车,AS便会帮你生成模板,我们只需要补全参数即可,如下所示。</p>    <pre>  /**   * bitmap转byteArr   *   * @param bitmap bitmap对象   * @param format 格式   * @return 字节数组   */  public static byte[] bitmap2Bytes(Bitmap bitmap, CompressFormat format) {      if (bitmap == null) return null;      ByteArrayOutputStream baos = new ByteArrayOutputStream();      bitmap.compress(format, 100, baos);      return baos.toByteArray();  }</pre>    <p>3. 块注释</p>    <p>块注释与其周围的代码在同一缩进级别。它们可以是 /* ... */ 风格,也可以是 // ... 风格( <strong>// 后最好带一个空格</strong> )。对于多行的 /* ... */ 注释,后续行必须从 * 开始, 并且与前一行的 * 对齐。以下示例注释都是OK的。</p>    <pre>  /*   * This is          // And so           /* Or you can   * okay.            // is this.          * even do this. */   */</pre>    <p>注释不要封闭在由星号或其它字符绘制的框架里。</p>    <p>Tip:在写多行注释时,如果你希望在必要时能重新换行(即注释像段落风格一样),那么使用/* ... */。</p>    <h3>测试规范</h3>    <p>业务开发完成之后,开发人员做单元测试,单元测试完成之后,保证单元测试全部通过同时单元测试代码覆盖率达到一定程度(这个需要开发和测试约定,理论上越高越好),开发提测。</p>    <p>// TODO...</p>    <h3>RN规范</h3>    <p>// TODO...</p>    <h3>其他的一些规范</h3>    <ol>     <li>合理布局,有效运用 <merge> , <ViewStub> , <include> 标签</li>     <li>相关联的方法尽量放在一起</li>     <li>不要忘了内存泄漏的检测</li>    </ol>    <h2>附录</h2>    <p>表1 UI控件缩写表</p>    <table>     <thead>      <tr>       <th>View</th>       <th>缩写</th>      </tr>     </thead>     <tbody>      <tr>       <td>TextView</td>       <td>txt</td>      </tr>      <tr>       <td>EditText</td>       <td>edit</td>      </tr>      <tr>       <td>Button</td>       <td>btn</td>      </tr>      <tr>       <td>ImageButton</td>       <td>ibtn</td>      </tr>      <tr>       <td>ImageView</td>       <td>img</td>      </tr>      <tr>       <td>ListView</td>       <td>lv</td>      </tr>      <tr>       <td>RadioGroup</td>       <td>rgroup</td>      </tr>      <tr>       <td>RadioButton</td>       <td>rbtn</td>      </tr>      <tr>       <td>ProgressBar</td>       <td>rbar</td>      </tr>      <tr>       <td>SeekBar</td>       <td>seek</td>      </tr>      <tr>       <td>CheckBox</td>       <td>cb</td>      </tr>      <tr>       <td>Spinner</td>       <td>spinner</td>      </tr>      <tr>       <td>TableLayout</td>       <td>table</td>      </tr>      <tr>       <td>TableRow</td>       <td>row</td>      </tr>      <tr>       <td>LinearLayout</td>       <td>ll</td>      </tr>      <tr>       <td>RelativeLayout</td>       <td>rl</td>      </tr>      <tr>       <td>ScrollView</td>       <td>scroll</td>      </tr>      <tr>       <td>SearchView</td>       <td>search</td>      </tr>      <tr>       <td>TabHost</td>       <td>thost</td>      </tr>      <tr>       <td>TabWidget</td>       <td>twidget</td>      </tr>     </tbody>    </table>    <p>表2 常见的英文单词缩写:</p>    <table>     <thead>      <tr>       <th>名称</th>       <th>缩写</th>      </tr>     </thead>     <tbody>      <tr>       <td>icon</td>       <td>ic (主要用在app的图标)</td>      </tr>      <tr>       <td>color</td>       <td>cl(主要用于颜色值)</td>      </tr>      <tr>       <td>divider</td>       <td>di(主要用于分隔线,不仅包括Listview中的divider,还包括普通布局中的线)</td>      </tr>      <tr>       <td>selector</td>       <td>sl(主要用于某一view多种状态,不仅包括Listview中的selector,还包括按钮的selector)</td>      </tr>      <tr>       <td>average</td>       <td>avg</td>      </tr>      <tr>       <td>background</td>       <td>bg(主要用于布局和子布局的背景)</td>      </tr>      <tr>       <td>buffer</td>       <td>buf</td>      </tr>      <tr>       <td>control</td>       <td>ctrl</td>      </tr>      <tr>       <td>delete</td>       <td>del</td>      </tr>      <tr>       <td>document</td>       <td>doc</td>      </tr>      <tr>       <td>error</td>       <td>err</td>      </tr>      <tr>       <td>escape</td>       <td>esc</td>      </tr>      <tr>       <td>increment</td>       <td>inc</td>      </tr>      <tr>       <td>infomation</td>       <td>info</td>      </tr>      <tr>       <td>initial</td>       <td>init</td>      </tr>      <tr>       <td>image</td>       <td>img</td>      </tr>      <tr>       <td>Internationalization</td>       <td>I18N</td>      </tr>      <tr>       <td>length</td>       <td>len</td>      </tr>      <tr>       <td>library</td>       <td>lib</td>      </tr>      <tr>       <td>message</td>       <td>msg</td>      </tr>      <tr>       <td>password</td>       <td>pwd</td>      </tr>      <tr>       <td>position</td>       <td>pos</td>      </tr>      <tr>       <td>server</td>       <td>srv</td>      </tr>      <tr>       <td>string</td>       <td>str</td>      </tr>      <tr>       <td>temp</td>       <td>tmp</td>      </tr>      <tr>       <td>window</td>       <td>wnd(win)</td>      </tr>     </tbody>    </table>    <p>程序中使用单词缩写原则:不要用缩写,除非该缩写是约定俗成的。</p>    <h2>参考</h2>    <p><a href="/misc/goto?guid=4958867432404484127" rel="nofollow,noindex">Android 开发最佳实践</a></p>    <p><a href="/misc/goto?guid=4959737840134796468" rel="nofollow,noindex">Android 编码规范</a></p>    <p><a href="/misc/goto?guid=4959740774793510404" rel="nofollow,noindex">阿里巴巴Java开发手册</a></p>    <p><a href="/misc/goto?guid=4959653345609509633" rel="nofollow,noindex">Google Java编程风格指南</a></p>    <h2> </h2>    <p>来自:http://www.jianshu.com/p/419f5357357d</p>    <p> </p>