编码规范.docx
《编码规范.docx》由会员分享，可在线阅读，更多相关《编码规范.docx（10页珍藏版）》请在冰豆网上搜索。
编码规范
编码规范
1技术原则
1.1代码规范化书写
代码规范化书写实现了脚本整体风格的一致，保证了同一个人不同时期写的脚本风格保持一致，以及同一个工作组中不同的开发人员编写的脚本风格保持一致。
因为开发不可能在孤立中进行，所以代码规范化书写是项目组人员合作沟通的前提。
1.2数据层、结构层、表现层分离
数据内容就是页面实际要传达的真正信息，包含数据、文档或者图片等。
这里强调的“真正”，是指纯粹的数据信息本身。
把信息内容以一种合适的方式格式化，简言之就是页面排版，例如：
分成标题、作者、章、节、段落和列表等，使内容更加具有逻辑性，条理清晰易读易懂，叫做“结构（Structure）”虽然定义了结构，但是内容还是相同的样式没有改变，例如标题字体没有变大，正文的颜色也没有变化，没有背景，没有修饰。
所有这些用来改变内容外观的东西，称之为“表现（Presentation）”“表现”的作用使内容看上去漂亮、赏心悦目、打动人心！
所有HTML和XHTML页面就是由“结构、表现和行为”这三方面组成的。
抽象一点理解，内容是基础层，然后是附加上去结构层和表现层，人对页面内容的交互及操作效果叫做“行为（Behavior）”,对于数据、结构与表现相分离，最早是在软件开发架构理论中提出来的。
UI设计师设计出页面模版，程序员负责内容数据的嵌入，数据可能是从数据库中提取出来，也可能是静态写入的提示性文字，最后形成一个新的页面展示给软件操作者。
模版文件的结构利用HTML＋XHTML标签来定义，而所有涉及表现的东西通通剥离出来，把它放到一个单独的文件里，这个单独的文件就是CSS。
1.3数据、结构与表现相分离的好处
程序员不需要过多的思考页面显示问题，而只需要根据模版效果把数据放入模版相应的位置。
界面的结构和表现由UI设计师负责。
填入结构的数据自觉套用设计好了的表现效果。
最后呈现一个实现功能的完整界面。
表现层的分离保持整个软件界面视觉的一致性，使改版也变得非常简单，修改样式表就可以了；
由于结构清晰，数据层相对独立，对数据的集成、更新、处理和再利用也更加方便灵活；
2编写规范
2.1目录结构及命名规则、
目录结构规范
1、目录建立的原则：
以最少的层次提供最清晰简便的访问结构。
2、根目录一般只存放index.htm以及其他必须的系统文件
3、在根目录中原则上应该按照系统的栏目结构，给每一个栏目开设一个目录，根据需要在每一个栏目的目录中开设一个images和media的子目录用以放置此栏目专有的图片和多媒体文件，如果这个栏目的内容特别多，又分出很多下级栏目，可以相应的再开设其他目录。
根目录下的images用于存放各页面都要使用的公用图片，子目录下的images目录存放本栏目页面使用的私有图片
4、所有JS,ASP,PHP等脚本存放在根目录下的scripts目录
5、所有CGI程序存放在根目录下的cgi-bin目录
6、所有CSS文件存放在根目录下style目录
7、每个语言版本存放于独立的目录。
例如：
简体中文gb
8、所有flash,avi,ram,quicktime等多媒体文件存放在根目录下的media目录
9、temp子目录放客户提供的各种文字图片等等原始资料，以时间为名称开设目录，将客户陆续提供的资料归类整理。
2.1.1文件和目录命名规范
1、文件命名的原则：
以最少的字母达到最容易理解的意义。
2、每一个目录中包含的缺省html文件，文件名统一用index.htm
3、文件名称统一用小写的英文字母、数字和下划线的组合，不得包含汉字、空格和特殊字符
4、尽量按单词的英语翻译为名称。
例如：
feedback（信息反馈），aboutus（关于我们）不到万不得已不要以拼音作为目录名称
5、多个同类型文件使用英文字母加数字命名，字母和数字之间用_分隔。
例如：
news_01.htm。
注意，数字位数与文件个数成正比，不够的用0补齐。
例如共有200条新闻，其中第18条命名为news_018.htm
2.1.2图片的命名规范
1、名称分为头尾两两部分，用下划线隔开。
2、头部分表示此图片的大类性质。
例如：
放置在页面顶部的广告、装饰图案等长方形的图片我们取名：
banner；标志性的图片我们取名为：
logo；在页面上位置不固定并且带有链接的小图片我们取名为button；在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：
menu；装饰用的照片我们取名：
pic；不带链接表示标题的图片我们取名：
title依照此原则类推。
3、尾部分用来表示图片的具体含义，用英文字母表示。
例如：
banner_sohu.gifbanner_sina.gifmenu_aboutus.gifmenu_job.giftitle_news.giflogo_police.giflogo_national.gifpic_people.jpgpic_hill.jpg.
4、有onmouse效果的图片，两张分别在原有文件名后加”_on”和”_off”命名
2.1.3其它文件命名规范
1、js的命名原则以功能的英语单词为名。
例如：
广告条的js文件名为:
ad.js
2、所有的CGI文件后缀为cgi。
所有CGI程序的配置文件为config.cgi
2.2html编写规则
2.2.1 一般原则
1、在编写模版文件，排布结构表格之前，要思考一个最佳方案，表格的嵌套尽量控制在三层以内；要考虑程序套用的可实现性、通用性、灵活性、预见性，所有内容均采用积木式组织，可替换和删除，并对总体结构不会造成破坏性影响
2、尽量避免两个标记，经验表明，这两个标记会带来许多麻烦
3、一个网页要尽量避免用整个一张大表格，所有的内容都嵌套在这个大表格之内。
因为浏览器在解释页面元素时，是以表格为单位逐一显示，如果一张网页是嵌套在一个大表格之内，那么很可能造成的后果就是，当浏览者敲入网址，他要先面对一片空白很长时间，然后所有的网页内容同时出现。
如果必须这样做，请使用
标记，以便能够使这个大表格分块显示4、排版中经常会遇到需要进行首行缩进的处理，不要使用全角空格来达到效果，规范的做法是在样式表中定义p{text-indent:
2em;}然后给每一段加上
标记，注意，一般情况下，请不要省略
结束标记
5、原则上，我们禁止用height=?
>来人为干预图片显示的尺寸，而且建议![]()
标签中不要带上width和height两个属性，这是因为制作过程中，图片往往需要反复的修改，这样可以避免人为干预图片显示的尺寸，尽可能的发挥浏览器自身的功能；但是这样的一个副作用是当网页还未加载图片时，不会留出图片的站位大小，可能会造成网页在加载过程中抖动（如果图片是插在一个固定大小的表格里的，不会有这个现象），尤其是当图片的尺寸较大时，这种现象会很明显，所以当预料到这种会明显导致网页抖动的情况会发生时，务必在最后给![]()
附上width和height属性
6、为了最大程度的发挥浏览器自动排版的功能，在一段完整的文字中尽量不要使用
来人工干预分段
7、不同语种的文字之间应该有一个半角空格，但避头的符号之前和避尾的符号之后除外，汉字之间的标要用全角标点，英文字母和数字周围的括号应该使用半角括号
8、为贯彻结构层和表现层分离的原则，严禁使用传统的HTML3.2/4.0控制表现的标签，例如,，还有本意用于结构后来被滥用于控制表现的标签，例如：
,
等。所有的字号都应该用样式表来实现，禁止在页面中出现标记， 标记，严禁在结构页面写表现标签
9、不要在网页中连续出现多于一个的也尽量少使用全角空格（英文字符集下，全角空格会变成乱码），空白应该尽量使用text-indent,padding,margin,hspace,vspace以及透明的gif图片来实现。
10、中英文混排时，我们尽可能的将英文和数字定义为verdana和arial两种字体
11、行距建议用百分比来定义，常用的两个行距的值是line-height:
120%/150%
12、系统中的路径全部采用相对路径
13、为保证系统和浏览器的兼容性，当设置背景图片时，要坚持用双引号。
14、“网页大小”为网页的所有文件大小的总和，包括HTML文件和所有的嵌入的对象。
页面大小保持在34K以下为合适
3代码规则
3.1head区标识
（head区是指首页HTML代码的
和之间的内容）3.1.1公司版权注释
–
Generator:
中国神华神东
CreationData:
2005-8-1
OriginalAuthor:
张三
–>
3.1.2网页显示字符集
简体中文：
繁体中文：
英语：
?
3.1.3简介
?
3.1.4网页的css文件定义，所有css文件尽量采用外部调用
3.1.5网页标题
这里是你的网页标题3.1.6所有的javascript脚本尽量采取外部调用
head区可以选择加入的标识
3.1.7设定网页的到期时间。
一旦网页过期，必须到fwq上重新调阅。
21:
57GMT”>
3.1.8禁止浏览器从本地机的缓存中调阅页面内容。
3.1.9用来防止别人在框架里调用你的页面。
3.1.10自动跳转。
5指时间停留5秒。
3.1.11网页搜索机器人向导.用来告诉搜索机器人哪些页面需要索引，哪些页面不需要索引。
CONTENT的参数有all,none,index,noindex,follow,nofollow。
默认是all。
3.1.12收藏夹图标
展开阅读全文
相关搜索