文档介绍:网站规划与建设第5章制定网站的设计规范
第5章制定网站的设计规范
本章要点
网站目录建设规
网站文件命名规范
数据字典命名规范
网页head区代码规范
网站代码编写规范
51>.1 网站目录建设规范
一个网站是由许许多多个文件组成的,它们不应该杂乱无章地堆放在一起,而应该是有序地排放在一起。这样不仅有利于团队合作开发,更为后续开发与转交第三方开发提供了便利,同时也是衡量软件开发质量的一项指标。
目录建立遵循的原则:
?? 以最少的层次提供最清晰最便捷的访问结构。
?? 根目录必须是DNS域名服务器指向的索引文件存放的目录。
?? ,以及其它必须的系统文件。
?? 网站公用图片应存放在根目录或各自语言版本目录(如果同时存在两种及以上语言版本)下的images目录中,而每个主要功能的私有图片也只能存放于各自独立目录下的images目录中。
……
2. 案例分析
(1)案例
在一次讨论网站设计规范专题会议上,B公司软件开发部负责人张文讲述了一个发生在以前一个项目开发过程中的一件事。
事情的大致情况是说某一天例会上,张文在听取每个小组分别汇报前一天的工作情况时,发现有两个开发小组都在自己功能目录下新建了一个子目录,用来存放图片。一个小组建立了image子目录,而另一个小组建立了images子目录。于是张文严厉地批评了不按规范操作的一个开发小组,责令立即修改且不能延误当天的开发任务。
于是张文要求与会者判断哪一个开发小组违反了哪条操作规范。
(2)分析
首先,依照网站目录建设基本原则,其中明确规定每个主要功能的私有图片只能存放于各自独立目录下的images目录中,可见其中一个开发小组违反了上述规定。
其次,即使可以根据具体项目来制定具体的网站目录建立规范,但通常不应该与基本原则相冲突。
所以很显而易见,建立image子目录的开发小组违反了操作规范,应该承担相应的责任。
3. 实现
针对出现的问题,张文进行了如下处理:
1)表扬建立images子目录的开发小组,号召其他小组向其学****br/>2)严厉批评建立image子目录的开发小组,告戒其他小组引以为戒,杜绝此类问题的再次出现。
3)要求每个开发小组再认真温****一下网站目录建立规范。
4)要求违反操作规范的开发小组立即改正错误。
5)要求违反操作规范的开发小组加快开发进度,不得延误当天的开发任务。
动手实践
网站文件命名规范
网站是由许多文件组成的,同一目录下的文件是排放在一起的。有意义的命名不仅有利于程序员理解其含义,而且为查找、排序、替换提供了便利,同时也是衡量软件开发质量的一项指标。
遵循以下命名的原则:
?? 以最少的字母表达最容易理解的意义。
?? 。
?? 。
?? 文件名称统一用小写的英文字母、数字和下划线的组合来命名,尽量按单词的英语翻译为名称。
?? 必须建立网站文件清单及其说明文档。
举例
网站文件命名规范[续]
2. 案例分析
(1)案例
在某一页面上需要放置两张鼠标感应图片,一张是当鼠标滑过时显示的图片,另一张是当鼠标滑出时显示的图片。
接到任务后,开发小组立即指派一名美工人员半小时做完了两张图片,并分别命名后放入指定的目录下。
假如自己就是那位美工人员,该如何为两张图片文件命名呢?
(2)分析
根据上述的命名规范,再结合实际要求,,。
数据字典命名规范
什么是数据字典?
数据字典(Data Dictionary)是以数据库中数据基本单元为单位,按一定顺序排列,对其内容作详细说明的数据集。
除了静态小型网站外,绝大多数网站拥有后台数据库,用来存放网站动态内容。
(1)对于数据表命名,一般遵循如下原则:
?? 以最少的单词概括数据表内容。
?? 表名尽可能简短,最大长度不应超过30个字符。
?? 表名由一个或多个英文单词组成,其中每个单词都采用单数形式,每个单词首字母要大写,单词间不用任何连接符号。如ProductInfo,ProductType等。
?? 如果整个网站系统又包含多个子系统,则需要在原表名之前加子系统名称,子系统名应为该子系统名称的缩写,并全部采用小写英文字符,如bbsTitle,b