Android项目实训过程中的编码规范的问题

基于Android平台的手机通讯录Web前端开发规范 ANDROID 项目实训过程中的是编码规范的问题

最近这个阶段我正在实施安庆师范学院3G班的项目实训，在前期的过程中，由于没有相对统一的开发规范，对项目研发过程带来的问题层出不穷，每次由于小组成员编码不规范导致的问题一大把，需要解决1~2个小时，这个过程所浪费的时间是痛苦的，也是很无奈的，后来我自己就定义了一些规范，希望能有所用。 的确，在后期的实施的过程中，由于前期我的这个预案，省了不少麻烦，学生项目整理起来也很容易了。现在我把这个规范贴出来，不作之材，请拍砖。 基于Android平台的手机通讯录Web前端开发规范 Android手机通讯录（WEB前端开发规范）

1、规范目的 ............................................................................................................................................................... 3 2、基本准则 ............................................................................................................................................................... 3 3、文件规范 ............................................................................................................................................................... 3 4、html书写规范 ....................................................................................................................................................... 4 5、css书写规范 ......................................................................................................................................................... 6 6、JavaScript书写规范 .............................................................................................................................................. 7 7、图片规范 ............................................................................................................................................................... 7 8、注释规范 ............................................................................................................................................................... 8 9、开发及测试工具约定 ........................................................................................................................................... 8 10、其他规范 ............................................................................................................................................................. 8 11、CSS Hack ............................................................................................................................................................. 8 基于Android平台的手机通讯录Web前端开发规范 1、规范目的 为提高团队协作效率, 便于后台人员添加功能及前端后期优化维护, 输出高质量的文档,同是为网站有一个更好的前端架构，网站的发展及未来打好一个基础。本文档如有不对或者不合适的地方请提出来。

2、基本准则

符合web标准, 语义化html, 结构表现行为分离, 兼容性优良. 页面性能方面, 代码要求简洁明了有序, 尽可能的减小服务器负载, 保证最快的解析速度.

3、文件规范

3.1、 html, css, js, images文件均归档至约定的目录中; 3.2、html文件命名:命名以中文命名，依实际模块命名，如果同一模块以_& title& _ 来组合命名, 以方便添加功能时查找对应页面，团结里的相互理解。

例如：我的好股网里的TAB命名 大模块名称_小模块的titile.html 我的好股网_关注的微博.html 3.3、 css文件命名: 英文命名, 后缀.css. 初始化样式reset.css，其他样式依实际模块页面需求命名，共用样式一般以模块考虑来划分命名,如有改版修改的css文件可以采用&_时间日期 基于Android平台的手机通讯录Web前端开发规范 例如：微博改版 版块名称_时间日期.css new_blog_1212.css 4.4、Js文件命名: 英文命名, 后缀.js. 共用common.js, 其他依实际模块需求命名. 5.5、图片命名: 4、html书写规范

4.1、文档类型声明及编码: 统一用Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">; 编码统一为charset=”utf-8″ />。目的:统一性和网站提高开发合作效率。

4.2、非特殊情况下样式文件必须外链至…之间;非特殊情况下JavaScript文件必须外链至页面底部之前;目的:网站的优化。

4.3、所有编码均遵循xhtml标准, 标签 & 属性 & 属性命名 必须由小写字母及下划线数字组成, 且所有标签必须闭合, 包括br (), hr(

4.4、充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等目的：减少代码量

4.5、语义化html, 如 标题根据重要性用h*(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素;目的：减少代码量，也有利于seo

4.5、尽可能减少div嵌套, 如

欢迎访问XXX, 您的用户名是用户名

4.6、引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.4.1.min.js; 引入插件, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js; 基于Android平台的手机通讯录Web前端开发规范 4.7、书写链接地址时, 必须避免重定向，例如：href=”http://www.haogu.com/”, 即须在URL地址后面加上“/”；

4.8、在页面中尽量避免使用style属性,即style=”…”除非考虑网站http请求，网站响应速度等因素比重情况具体分析;

4.9、严格区分作为内容的图片和作为背景的图片。作为背景的图片采用Css sprite技术，放在一张大图里。Css sprite技术的优点是减少了http请求数，但使图片面向css的backround-position增加了耦合度，也增加了维护成本。如果图片有修改，不要删除已添加的图片，在空白处新增修改后的图片，减少修改风险。 下图为腾讯的Css sprite背景图。

4.10、图片必须加上alt属性; 给重要的元素和截断的元素加上title;目的:有利于seo，搜索引擎的爬虫。

4.11、给区块代码及重要功能(比如循环)加上注释, 方便后台程序员嵌套模版; 4.12、特殊符号使用: 尽可能使用代码替代: 比如 <(<) & >(>) & 空格( ) & »(») 等等; 4.13、书写页面过程中, 请考虑向后扩展性;