1 / 16
文档名称:

android开发规范.docx

格式:docx   大小:318KB   页数:16页
下载后只包含 1 个 DOCX 格式的文档,没有任何的图纸或源代码,查看文件列表

如果您已付费下载过本站文档,您可以点这里二次下载

分享

预览

android开发规范.docx

上传人:iris028 2022/5/8 文件大小:318 KB

下载得到文件列表

android开发规范.docx

文档介绍

文档介绍:1、简介

随着软件开发项目的日益庞大,随着项目参与人员的逐渐增加,项目管理、人员合作和文档交流等诸多方面都面临的巨大挑战。为了更好地管理项目资源;为了方便参与人员之间的团队协作;为了高效地交流项目文档; 按键






输入框背景
白色分割线
anim
全部单词小写,单词间以下划线分割,采用以下规则:
模块名_逻辑名称
逻辑名称



strings
strings的name命名使用
Camel命名法,采用以下规则:
模块名+逻辑名称
逻辑名称
mainMenuAbout主菜单按键文字
friendTitle 好友模块标题栏
friendDialogDel 好友删除提示
loginCheckEmail 登录验证
dialogTitle弹出框标题
buttonOk 确认键
loading 加载文字
appName
colors
colors的name命名使用
Camel命名法,采用以下规则:
模块名+逻辑名称
颜色
friendInfoBg
friendBg
transparent
gray
styles
colors的name命名使用
Camel命名法,采用以下规则:
模块名+逻辑名称
逻辑名称
MainTabBottom
BlueBigButton
GraySmallButton
FriendList

Java 程序有两类注释:实现注释(implementation comments)和文档注释(document comments)。实现注释是使用/*...*/和//界定的注释。文档注释(被称为"doc comments")由/**...*/界定。文档注释可以通过JavaDoc工具转换成HTML 文件。

所有的源文件都应该在开头有一个注释,其中列出类名、版本信息、日期和版权声明。
如下:
/*
* 文件名
* 包含类名列表
* 版本信息,版本号
* 创建日期
* 版权声明
*/
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_declaration}

每一个类都要包含如下格式的注释,以说明当前类的功能等。
/**
* ***@name 类名
* ***@author 原作者
* ***@description实现的主要功能。
* ***@date创建日期
* 修改者,修改日期,修改内容。
*/
Eclipse中的配置方式:

每一个方法都要包含 如下格式的注释 包括当前方法的用途,当前方法参数的含义,当前方法返回值的内容和抛出异常的列表。
/**
* 方法的一句话概述
* 方法详述(简单方法可不必详述)
* ***@param s 说明参数含义
* ***@return 说明返回值含义
* ***@throws IOException 说明发生此异常的条件
* ***@throws NullPointerException 说明发生此异常的条件
*/

成员变量和常量需要使用java doc形式的注释,以说明当前变量或常量的含义
/**
* XXXX含义
*/

方法内部的注释 如果需要多行 使用/*…… */形式,如果为单行是用//……形式的注释。不要在方法