【Android源码 栏目提醒】:网学会员Android源码 为您提供Android开发代码规范 - 其它资料参考,解决您在Android开发代码规范 - 其它资料学习中工作中的难题,参考学习。
Android 开发代码规范要求: 移动开发组成员基本上要按这个要求来写代码,前 4 周每周抽时间看一遍,以达到以后开发中熟练运 用的效果,另外可多多参考
android 的官方
源码 的写法1.命名基本原则 在面向对象编程中,对于类,对象,方法,变量等方面的命名是非常有技巧的。
比如,大小写的区分,使用不同字母开头等等。
但究其本,追其源,在为一个资源其名称的时候,应该本着描述性以及唯一性这两大特征来命名,才能保证资源之间不冲突,并且每一个都便于记忆。
对于理解应用程序的逻辑流,命名方案是最有影响力的一种帮助。
名称应该说明“什么”而不是“如何”。
命名原则是:使名称足够长以便有一定的意义,并且足够短以避免冗长。
唯一名称在编程上仅用于将各项区分开。
以下几点是规范的命名方法。
2.命名基本规范2.1.编程基本命名规范(1)避免难懂的名称,如属性名 xxK8,这样的名称会导致多义性。
(2) 在面向对象的语言中, 如 在类属性的名称中包含类名是多余的, Book.BookTitle,而是应该使用 Book.Title。
(3)在允许函数重载的语言中,所有重载都应该执行相似的函数。
(例程是某个系统(4)使用动词-名词的方法来命名对给定对象执行特定操作的例程,如 CalculateInvoiceTotal。
对外提供的功能接口或服务的集合)(5)只要合适,在变量名的末尾或开头加计算限定符(Avg、Sum、Min、Max、Index)。
(6)在变量名中使用互补对,如 min/max、begin/end 和 open/close。
(7)布尔变量名应该包含 Is,这意味着 Yes/No 或 True/False 值,如 fileIsFound。
(8)即使对于可能仅出现在几个代码行中的生存期很短的变量,仍然使用有意义的名 称。
仅对于短循环索引 使用单字母变量名,如 i 或 j。
(9)为了帮助区分变量和例程,对例程名称使用 Pascal 大小写处理 CalculateInvoiceTotal,其中每个单词的第 一个字母都是大写的。
对于变量名,使用 camel 大小写处理 documentFormatType,其中除了第一个单词 外每个单词的第一个字母都是大写的。
(10)不要使用原义数字或原义字符串,而是使用命名常数,NUM_DAYS_IN_WEEK ,以便于维护和理解。
(11) 全局变量应以 m 开头 2.2.分类命名规范(1)包的命名 Java 包的名字都是由小写单词组成。
但是由于 Java 面向对象编程的特性,每一名 Java 程序员都可以编写属于自己的 Java 包,为了保障每个 Java 包命名的唯一性,在最新的 Java 编程规范中,要求程序员在自己定义的包的名称之前加上唯一的前缀。
由于互联网上的域名称是不会重复的,所以程序员一般采用自己在互联网上的域名称作为自己程序包的唯一前缀。
例如: net.frontfree.javagroup(2)类的命名 类的名字必须由大写字母开头而单词中的其他字母均为小写;如果类名称由多个单词组成,则每个单词的首字母均应为大写例如 TestPage;如果类名称中包含单词缩写,则这个所写词的每个字母均应大写,如:XMLExample还有一点命名技巧就是由于类是设计用来代表对象的,所以在命名类时应尽量选择名词。
例如: Circle(3)方法的命名 方法的名字的第一个单词应以小写字母作为开头,后面的单词则用大写字母开头。
例如: sendMessge(4).常量的命名 常量的名字应该都使用大写字母,并且指出该常量完整含义。
如果一个常量名称由多个单词组成,则应该用下划线来分割这些单词。
例如: MAX_VALUE(5)参数的命名 参数的命名规范和方法的命名规范相同,而且为了避免阅读程序时造成迷惑,请在尽量保证参数名称为一个单词的情况下使参数的命名尽可能明确。
(6)Javadoc 注释 Java 除了可以采用我们常见的注释方式之外,Java 语言规范还定义了一种特殊的注释,也就是我们所说的Javadoc 注释,它是用来记录我们代码中的 API 的。
Javadoc 注释是一种多行注释,以/开头,而以/结束,注释可以包含一些 HTML 标记符和专门的关键词。
使用 Javadoc 注释的好处是编写的注释可以被自动转为在线文档,省去了单独编写程序文档的麻烦。
例如:/ This is an example of Javadoc author darchon version 0.1 10/11/2002/ 在每个程序的最开始部分,一般都用 Javadoc 注释对程序的总体描述以及版权信息,之后在主程序中可以为每个类、接口、方法、字段添加 Javadoc 注释,每个注释的开头部分先用一句话概括该类、接口、方法、字段所完成的功能,这句话应单独占据一行以突出其概括作用,在这句话后面可以跟随更加详细的描述段落。
在描述性段落之后还可以跟随一些以 Javadoc 注释标签开头的特殊段落,例如上面例子中的auther 和version,这些段落将在生成文档中以特定方式显示。
虽然为一个设计低劣的程序添加注释不会使其变成好的程序,但是如果按照编程规范编写程序并且为程序添加良好的注释却可以帮助你编写出设计完美,运行效率高且易于理解的程序,尤其是在多人合作完成同一项目时 ,花费一点时间去适应一下 Java 编程规范是有好处的。
编程规范就变得更加重要。
俗话说“磨刀不误砍柴工”3.分类命名规范3.1.基本数据类型命名规范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 srtName3.2.控件命名规范TextView :txt_描述 Button :btn_描述ImageButton :imgBtn_描述 ImageView :imgView_描述CheckBox :chk_描述 RadioButton :rdoBtn_描述AnalogClock :anaClk_描述 DigitalClock :DgtClk_描述DatePicker :dtPk_描述 TimePicker :tmPk _描述ToggleButton :tglBtn_描述 EditText:edtTxt_描述ProgressBar:lcb_描述 SeekBar:skBar _描述AutoCompleteTextView:autoTxt_描述 MultiAutoCompleteTextView:mlAutoTxt_描述ZoomControls:zmCtrl_描述 Include:ind_描述VideoView:vdoVi_描述 WebView:webVi_描述RatingBar:ratBar_描述 Tab:tab__描述Spinner:spn_描述 Chronometer:Cmt_描述ScrollView:sclVi_描述 TextSwitcher:txtSwt_描述Gallery:gal_描述 ImageSwitcher:imgSwt_描述GridView:gV_描述 ListView:lVi_描述ExpandableList: epdLt_描述 MapView: mapVi_描述控件说明如下: TextView - 文本显示控件 Button - 按钮控件 ImageButton - 图片按钮控件 ImageView - 图片显示控件 CheckBox - 复选框控件 RadioButton - 单选框控件 AnalogClock - 钟表(带表盘的那种)控件 DigitalClock - 电子表控件 DatePicker - 日期选择控件 TimePicker - 时间选择控件 ToggleButton - 双状态按钮控件 EditText - 可编辑文本控件 ProgressBar - 进度条控件 SeekBar - 可拖动的进度条控件 AutoCompleteTextView - 支持自动完成功能的可编辑文本控件 MultiAutoCompleteTextView - 支持自动完成功能的可编辑文本控件,允许输入多值(多值之间会自动地用指定的分隔符 分开) ZoomControls - 放大/缩小按钮控件 Include - 整合控件 VideoView - 视频播放控件 WebView - 浏览器控件 RatingBar - 评分控件 Tab - 选项卡控件 Spinner - 下拉框控件 Chronometer - 计时器控件 ScrollView - 滚动条控件 TextSwitcher - 文字转换器控件(改变文字时增加一些动画效果) Gallery –画廊控件 ImageSwitcher - 图片转换器控件(改变图片时增加一些动画效果) GridView - 网格控件 ListView - 列表控件 ExpandableList - 支持展开/收缩功能的列表控件3.3.变量命名规范变量命名:前缀类型描述意义描述前缀:成员变量:m_ 局部变量:l_ 形参:a_常量:大写_ 枚举值:em_3.4.程序规范工程的命名为:描述应用程序名的命名为:描述App4.代码书写规范 ,并一致地使用此标准。
用规定的缩进对齐代码节。
(1)建立标准的缩进大小(如四个空格) 。
(2)在发布源代码的硬拷贝版本时使用特定的字体以及字号(新宋体、小五号)(3)在括号对对齐的位置垂直对齐左括号和右括号,如: for i0 i
上一篇:
心联Android数字可视对讲方案2012年5月
下一篇:
天亮之后