android代码书写规范

《android代码书写规范》由会员分享，可在线阅读，更多相关《android代码书写规范（9页珍藏版）》请在金锄头文库上搜索。

1、androidandroid 代码书写规范代码书写规范篇一：Android 开发代码规范Android 开发代码的规范 1.命名基本原则 在面向对象编程中，对于类，对象，方法，变量等方面的命名是非常有技巧的。比如，大小写的区分， 使用不同字母开头等等。但究其本，追其源，在为一个资源其名称的时候，应该本着描述性以及唯一性这两大特征来命名，才能保证资源之间不冲突，并且每一个都便于记忆。 对于理解应用程序的逻辑流，命名方案是最有影响力的一种帮助。名称应该说明“什么”而不是“如何” 。命名原则是：使名称足够长以便有一定的意义，并且足够短以避免冗长。唯一名称在编程上仅用于将各项区分开。以下几点是规范的命

2、名方法。 2.命名基本规范 编程基本命名规范 （1）避免难懂的名称，如属性名 xxK8，这样的名称会导致多义性。 （2） 在面向对象的语言中，在类属性的名称中包含类名是多余的，如，而是应该使用。 （3）在允许函数重载的语言中，所有重载都应该执行相似的函数。 （4）使用动词-名词的方法来命名对给定对象执行特定操作的例程，如 CalculateInvoiceTotal()。 （例程是某个系统 对外提供的功能接口或服务的集合） （5）只要合适，在变量名的末尾或开头加计算限定符（Avg、Sum、Min、Max、Index） 。 （6）在变量名中使用互补对，如 min/max、begin/end 和 o

3、pen/close。 （7）布尔变量名应该包含 Is，这意味着 Yes/No 或 True/False 值，如 fileIsFound。 （8）即使对于可能仅出现在几个代码行中的生存期很短的变量，仍然使用有意义的名 称。仅对于短循环索引 使用单字母变量名，如 i 或 j。 （9）为了帮助区分变量和例程，对例程名称使用Pascal 大小写处理 (CalculateInvoiceTotal)，其中每个单词的第 一个字母都是大写的。对于变量名，使用 camel 大小写处理 (documentFormatType)，其中除了第一个单词外每个单词的第一个字母都是大写的。 （10）不要使用原义数字或原义字

4、符串，而是使用命名常数，NUM_DAYS_IN_WEEK ，以便于维护和理解。 分类命名规范 （1）包的命名 Java 包的名字都是由小写单词组成。但是由于 Java面向对象编程的特性，每一名 Java 程序员都可以编写属于自己的 Java 包，为了保障每个 Java 包命名的唯一性，在最新的 Java 编程规范中，要求程序员在自己定义的包的名称之前加上唯一的前缀。由于互联网上的域名称是不会重复的，所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。 例如： （2）类的命名 类的名字必须由大写字母开头而单词中的其他字母均为小写；如果类名称由多个单词组成，则每个单词的首字母均应为大

5、写例如 TestPage；如果类名称中包含单词缩写，则这个所写词的每个字母均应大写，如：XMLExample,还有一点命名技巧就是由于类是设计用来代表对象的，所以在命名类时应尽量选择名词。例如： Circle （3）方法的命名 方法的名字的第一个单词应以小写字母作为开头，后面的单词则用大写字母开头。例如： sendMessge （4）.常量的命名 常量的名字应该都使用大写字母，并且指出该常量完整含义。如果一个常量名称由多个单词组成，则应该用下划线来分割这些单词。例如： MAX_VALUE （5）参数的命名 参数的命名规范和方法的命名规范相同，而且为了避免阅读程序时造成迷惑，请在尽量保证参数名称

6、为一个单词的情况下使参数的命名尽可能明确。 （6）Javadoc 注释 Java 除了可以采用我们常见的注释方式之外，Java语言规范还定义了一种特殊的注释，也就是我们所说的Javadoc 注释，它是用来记录我们代码中的 API 的。Javadoc 注释是一种多行注释，以/*开头，而以*/结束，注释可以包含一些 HTML 标记符和专门的关键词。使用Javadoc 注释的好处是编写的注释可以被自动转为在线文档，省去了单独编写程序文档的麻烦。例如： /* * This is an example of * Javadoc * author darchon * version , 10/11/XX

7、*/ 在每个程序的最开始部分，一般都用 Javadoc 注释对程序的总体描述以及版权信息，之后在主程序中可以为每个类、接口、方法、字段添加 Javadoc 注释，每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能，这句话应单独占据一行以突出其概括作用，在这句话后面可以跟随更加详细的描述段落。在描述性段落之后还可以跟随一些以 Javadoc 注释标签开头的特殊段落，例如上面例子中的auther 和version，这些段落将在生成文档中以特定方式显示。 虽然为一个设计低劣的程序添加注释不会使其变成好的程序，但是如果按照编程规范编写程序并且为程序添加良好的注释却可以帮助你编写出设计完

8、美，运行效率高且易于理解的程序，尤其是在多人合作完成同一项目时编程规范就变得更加重要。俗话说“磨刀不误砍柴工” ，花费一点时间去适应一下 Java 编程规范是有好处的。 3.分类命名规范 基本数据类型命名规范 Integer：int+描述 Char：chr+描述 Boolean：bln+描述 Long：lng+描述 Short：shr +描述 Double：dbl+描述 String：str+描述 Float：flt+描述 Single：sng+描述 DataTime：dt+描述 Array：arr+描述 Object：obj+描述 如：String srtName; 控件命名规范 控件说明如

9、下： ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?TextView - 文本显示控件 Button - 按钮控件 ImageButton - 图片按钮控件 ImageView - 图片显示控件 CheckBox - 复选框控件 RadioButton - 单选框控件 AnalogClock - 钟表（带表盘的那种）控件 DigitalClock - 电子表控件 DatePicker - 日期选择控件 TimePicker - 时间选择控件 ToggleButton - 双状态按钮控件 EditText - 可编辑文本控件 ProgressBar - 进度条控件 SeekBar -

10、 可拖动的进度条控件 AutoCompleteTextView - 支持自动完成功能的可编辑文本控件 ? MultiAutoCompleteTextView - 支持自动完成功能的可编辑文本控件，允许输入多值（多值之间会自动地用指 定的分隔符 分开） ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ZoomControls - 放大/缩小按钮控件 Include - 整合控件 VideoView - 视频播放控件 WebView - 浏览器控件 RatingBar - 评分控件 Tab - 选项卡控件 Spinner - 下拉框控件 Chronometer - 计时器控件 Scro

11、llView - 滚动条控件 TextSwitcher - 文字转换器控件（改变文字时增加一些动画效果） Gallery 画廊控件 ImageSwitcher - 图片转换器控件（改变图片时增加一些动画效果） GridView - 网格控件 ListView - 列表控件 ExpandableList - 支持展开/收缩功能的列表控件 变量命名规范 变量命名：前缀+类型描述+意义描述 前缀： 成员变量：m_* 局部变量：l_* 形参：a_* 常量：大写_*枚举值：em_* 程序规范 工程的命名为：描述 应用程序名的命名为：描述+App 篇二：android 书写规范说明书写规范说明 1、简介

12、定义 2、编码规范代码风格 代码内的空行、缩进、对齐、换行、间隔等代码风格均按照的标准。只需使用进行代码格式化即可。 Eclipse中配置方式： 基本命名规范 控件命名规范 资源文件命名规范 注释 Java 程序有两类注释：实现注释(implementation comments)和文档注释(document comments)。实现注释是使用/*.*/和/界定的注释。文档注释(被称为“doc comments“)由/*.*/界定。文档注释可以通过 JavaDoc工具转换成 HTML 文件。 文件注释 如下：/* 所有的源文件都应该在开头有一个注释，其中列出类名、版本信息、日期和版权声明。 *

13、 文件名 * 包含类名列表 * 版本信息，版本号 * 创建日期 * 版权声明 */Eclipse 中的配置方式： 需要配置的注释格式如下： /* * title:$file_name * TODO 包含类名列表 * Copyright (C) Shenzhen Futuo Technology right reserved. * version：,$date */ $filecomment $package_declaration $typecomment /*name $type_name * description * author max * date $date */ $type_de

14、claration 篇三：Android 学习书写规范Android 学习书写规范 一.书写规范： 1. 编码方式统一用 UTF-8。 2. 花括号不要单独一行，和它前面的代码同一行。而且，花括号与前面的代码之间用一个空格隔开。 3. 空格的使用 if、else、for、switch、while 等逻辑关键字与后面的语句留一个空格隔开。运算符两边各用一个空格隔开。 方法的每个参数之间用一个空格隔开。 4.空行的使用 将逻辑相关的代码段用空行隔开，以提高可读性。空行也只空一行，不要空多行。在以下情况需用一个空行： 两个方法之间 方法内的两个逻辑段之间 方法内的局部变量和方法的第一条逻辑语句之间

15、常量和变量之间 5.当一个表达式无法容纳在一行内时，可换行显示，另起的新行用 8 个空格缩进。 6.一行声明一个变量，不要一行声明多个变量，这样有利于写注释。 7.使用快捷键进行代码自动格式化。 Windows：CTRL+ALT+L Mac：OPTION+COMMAND+L 8.一个方法最多不要超过 40 行代码。 9.范围型的常量用枚举类定义，而不要直接用整型或字符，这样可以减少范围值的有效性检查。 10.文字大小的单位统一用 sp，元素大小的单位统一用 dp。 11. 应用中的字符串统一在中定义，然后在代码和布局文件中引用。 12. 颜色值统一在中定义，然后在代码和布局文件中引用。另外，不要在代码和布局文件中引用系统的颜色，除了透明。 更多 Android 学习培训信息，请关注红树林教育。