团队-及格成绩查询系统-代码设计规范

逆流而上

及格成绩查询系统 代码规范


 

一、前言:

本编程规范适用于编写HTML/CSS代码,本规范并不是一个一成不变的必须严格遵守的条文,特殊情况下应灵活应对,做到变通。

 

二、HTML编码:

HTML是一种标记语言,HTML没有任何真正的编程语言中的循环或是流程控制语句。然而,HTML代码的格式和风格是非常重要的,因为要经常对HTML代码进行维护和修改,因此HTML代码必须有很清晰的逻辑结构和布局,增强可读性,而使其易懂和易于维护。HTML代码本身是不区分大小写的,但是为了更好的统一代码布局,本项目中HTML文件标记都以小写为主。

 

三、软件:

编码同一使用HBuilder软件;浏览器统一使用最新版Google浏览器。

 

四、标记规范:

1.标记应对应编码,不可出现交叉编码,例:<p><font>内容</p></font>;

2.开始和关闭标记放在同一行内;

3.因不涉及联网,HTML文件头基本标记为:<!DOCTYPE html>;

4.对于标记内的属性,务必使用双引号包围;

5.对于img图片标签,务必在属性栏中添加alt=“图片描述文字”;

 

五、标记的缩进规范:

1.最高一级父标记采用左对齐顶个方式书写;

2.下一级标记采用左对齐后,缩进一个Tab键的方式来缩写,再下一级以此类推;

3.同一级标记的首字符上下应对齐;

 

六、HTML文件引入CSS样式代码和JavaScript代码规范:

CSS样式代码引入:<link rel="stylesheet" type="text/css" href="引入文件名.css" />;

JavaScript代码引入:<script type="text/javascript" src="引入文件名.js"></script>;

 

七、HTML注释标签:

在每个功能块前添加注释标签以方便阅读编码含义;<!--注释内容-->;

 

八、CSS编码要求:

所有代码以小写字母的形式编写;样式代码采用一种样式占一行并使用Tab键缩进,例如: width:111px;(换行)height:111px; ;给重要区的代码添加注释内容:/*注释内容*/;

 

九、CSS样式表规范:

Id和class命名采用该版块的英文单词或组合命名,每个单词都用小写,用下划线连接起来,例如:content_main(主要内容区);

 

十、JS样式规范:

每个函数之间需要有回车间隔;重要部分代码需要有注释来增加代码可读性/*注释内容*/;函数名采用驼峰式写法并符合见名之意的格式,例:

function chessMain(){

正文;

}

变量命名采用单词首字母大写其余字母小写,例:StartChess = ;常量命名采用单个单词命名;

posted @ 2017-11-15 19:41  L龙先生  阅读(475)  评论(0编辑  收藏  举报