网站开发规范.docVIP

========网站开发规范======== 前 言 任何一个项目或者系统开发之前都需要定制一个开发约定和规则，这样有利于项目的整体风格统一、代码维护和扩展。由于Web项目开发的分散性、独立性、整合的交互性等，所以定制一套完整的约定和规则显得尤为重要。本文档将定制一系列约定和规则，他们分别包括网站项目管理规范、文件夹命名规则、文件名命名规则、程序代码编程风格、数据库设计约定。这些规则和约定需要与开发人员、设计人员和维护人员共同讨论定制，将来开发都将严格按规则或约定开发。每个团队开发都应有自己的一套规范，一个优良可行的规范可以使我们工作得心应手事半功倍，这些规范都不是唯一的标准不存在对与错，也许有些地方与你当前使用的习惯相驳，很多地方都有争议，各自都有比较充分的理由阐述自己的观点，所以只好根据具体情况来采用相应的策略。 一、文件结构： 1. 每一个目录中应该包含一个缺省的html 文件，文件名统一用index.htm 2. 目录、文件的名称统一用小写的英文字母、数字和下划线的组合，以英文字母开头，其中不得包含汉字、空格和特殊字符。目录的命名请尽量以英文为指导，不到万不得已不要以拼音作为目录名称，经验证明，用拼音命名的目录往往连一个月后的自己都看不懂。详细规定参照：《天行健网站开发命名详细规范》。 3. 命名原则的指导思想一是使得你自己和工作组的每一个成员能够方便的理解每一个文件的意义，二是当我们在文件夹中使用“按名称排例”的命令时，同一种大类的文件能够排列在一起，以便我们查找、修改、替换、计算负载量等等操作 。 4. 下面以“新闻”（包含“国内新闻”和“国际新闻”）这个栏目来说明html 文件的命名原则 ： 在根目录下开设news目录 第一条缺省新闻取名index.htm 所有属于“国内新闻”的新闻依次取名为：china_1.htm, china_2.htm, … 所有属于“国际新闻”的新闻依次取名为：internation_1.htm, internation _2.htm, … 如果文件的数量是两位数，请将前九个文件命名为：china_01.htm, china_02.htm 以保证所有的文件能够在文件夹中正确排序。 5. 图片的命名原则遵循以下几条规范： 名称分为头尾两两部分，用下划线隔开。 头部分表示此图片的大类性质，例如广告、标志、菜单、按钮等等。 一般来说： 放置在页面顶部的广告、装饰图案等长方形的图片我们取名：banner 标志性的图片我们取名为：logo 在页面上位置不固定并且带有链接的小图片我们取名为button 在页面上某一个位置连续出现，性质相同的链接栏目的图片我们取名：menu 装饰用的照片我们取名：pic 不带链接表示标题的图片我们取名：title 依照此原则类推。 尾部分用来表示图片的具体含义。 下面是几个样例，大家应该能够一眼看明白图片的意义： banner_sohu.gif banner_sina.gif menu_aboutus.gif menu_job.gif title_news.gif logo_police.gif logo_national.gif pic_people.jpg pic_hill.jpg. 6. 目录建立的原则：以最少的层次提供最清晰简便的访问结构。 根目录。 根目录指DNS域名服务器指向的索引文件的存放目录。 服务器的ftp上传目录默认为html 根目录文件 根目录只允许存放index.html和main.html文件，以及其他必须的系统文件。 每个语言版本存放于独立的目录。已有版本语言设置为： 简体中文 \gb 繁体中文 \big5 英 语 \en 日 语 \jp 每个主要功能(主菜单)建立一个相应的独立目录。 根目录下的images为存放公用图片目录，每个目录下私有图片存放于各自独立images目录. 例如：\menu1\images \menu2\images 所有的js文件存放在根目录下的js目录 所有的CSS文件存放在根目录下的css目录 所有的CGI程序存放在根目录并列目录\cgi_bin目录 7. 示例：目前公司后台开发的整个网站目录基础结构如下： / 根目录 |--- admin (管理后台文件夹) |--- ………… |--- css (存放网站样式表文件) |--- ………… |--- databases (存放网站用数据库) |--- ………… |--- images (存放网站图片文件，大项目根据栏目的名称建立相应的子目录) |--- ………… |-- inc (存放包含文件) |-- conn (数