文件命名规则

网站文件命名规则

关于文件的命名，看似无足重轻，但实际上若是没有良好的命名规则进行必要的约束，一味的乱起名称，最终致使的结果就是整个网站或是文件夹没法管理。因此，命名规则在这里一样很是重要。 须要特别注意的时候，网站文件或文件夹命名请尽可能避免使用中文字符命名。

文件的命名

　　以最少的字母达到最容易理解的意义。
　　索引文件统一使用index.html文件名(小写) index.html文件统一做为"桥页"，不制做具体内容，仅仅做为跳转页和meta标签页。主内容页为main.html。
　　按菜单名的英语翻译取单一单词为名称。全部单英文单词文件名都必须为小写，全部组合英文单词文件名第二个起第一个字母大写； 全部文件名字母间连线都为下划线。
　　例如： 关于咱们 \aboutus
　　　　　　信息反馈 \feedback
　　　　　　产　　品 \product

图片的命名

　　以图片英语字母为名。以最少的字母达到最容易理解的意义。
　　对于较小的图片，咱们使用以下格式的命名 ：
　　　　　　sm.kahn.gif
　　其中，sm 表明“small”，kahn 表明图片的内容。较大图像的命名规则也同样，不过是以 bg 开头的：
　　　　　　bg.kahn.gif
　　用以区分不一样图像的命名规则应当是全站通用的，这样能够尽可能避免将不一样的名称搅混。

网站目录的命名

　　目录创建的原则是以最少的层次提供最清晰简便的访问结构。
　　服务器的ftp上传目录默认为html 根目录文件 根目录只容许存放index.html和main.html文件，以及其余必须的系统文件。
　　每一个语言版本存放于独立的目录。已有版本语言设置为： 简体中文 \gb 繁体中文 \big5 英 语 \en 日 语 \jp 每一个主要功能(主菜单)创建一个相应的独立目录。 根目录下的images为存放公用图片目录，每一个目录下私有图片存放于各自独立images目录.
　　例如： \menu1\images
　　　　　　\menu2\images
　　另外，全部的js文件存放在根目录下统一目录\script 全部的CSS文件存放在根目录下的style目录 全部的CGI程序存放在根目录并列目录\cgi_bin目录。
　　对于一些信息更新量比较大的站点或是栏目，还能够采用一种更为特殊的方式来进行文件架的命名，这样能使得往后的维护更加方便，这样的方式就是使用“单一单词命名的目录”+“年年年年_月月_日日”的方式命名，最后的“日日”是根据更新量大小可选择的，若是每日更新量很大则能够加上“日日”。
　　例如： \news\2005_08\
　　　　　　\news\2005_09\
　　　　　　\news\2005_10_12\

 

Dreamweaver文件的命名规则

　　在Dreamweaver中用户能够对一系列不一样类型的对象进行命名，这些对象包括图片、层、表单、文件、数据库域等，这些对象将会被许多不一样的工做引擎进行分析处理，这些工具包括各类浏览器、JavaScript脚本解析器、网络服务器、应用程序服务器、查询语言等等。
　　若是某个对象的名称没法被某个解析器识别，就有可能会致使故障的发生，更加麻烦的是用户可能很难发现问题的缘由，例如某个具体的特效没法正确显示，或者是在某个特殊阶段没法正确显示，有时故障可能只会在某种特殊状况或在使用某个浏览器时发生，而在其它状况下保持正常，用户将很难分析出故障是因为命名问题而致使的。
　　因为须要命名的对象的种类不少，对这些对象进行解析的引擎工具也不少，所以用户在给这些对象命名时应该遵循一个常规的标准，以确保广泛兼容性。命名的基本原则就是：使用独一无二的、小写、不带空格的名称，名称应由字母和数字组成，并以字母开始，名称中能够包含"_"符号。

独一无二

　　请确保某对象的名称与其它对象不一样，保证其独一无二的属性。
　　例如： 你能够将某对象命名为"feedback_button_3"

小写

　　有些服务器和脚本解析器对文件名的大小写也进行检查，而为了不因大小写引发的不兼容问题，建议用户在命名时所有使用小写文件名。

不带空格

　　不一样的解析器对空格等符号的解析结果不一样，例如某些解析器会把空格视为某个十六进制的数值，所以建议用户使用不带空格的单词作为文件对象的名称。

词数混合

　　用户在命名中能够随意使用26个罗马字母以及10个阿拉伯数字，而不建议使用其它标点符号。

以字母开始

　　有些解析器不喜欢以数字开头的文件名。
　　例如： 在某些浏览器中的JavaScript脚本内部，若是使用"alpha23"这样的名称就不会出现问题，而若是使用"23alpha"这样的名称就可能会发生故障。

可包含"_"符号

　　为了使某个对象的文件名独一无二，用户能够经过使用"_"符号来更加详细地描述文件名。
　　例如： 某对象的文件名能够是"jd_background_17"。
　　除了上述原则标准以外，咱们还须要注意一些其它状况，如文件名与系统的冲突。某些文件名可能知足上述标准，但可能还会致使故障的发生，缘由是由于它们与系统产生了冲突。
　　例如：当在使用JavaScript脚本函数时，不建议用户将某个变量命名为"for"，由于"for"在本系统下是一个工做语言字串，使用其命名某个变量可能会致使解析器工做出错。许多程序都有一些保留名称，这些名称通常不建议用户使用。 　
　　例如：用户使用某个SQL程序保留的名称来命名某个数据库域，SQL对其进行分析时就可能会报错。
　　此外，用户在将不一样来源的代码编到一块儿时，应该注意文件名的冲突状况。
　　例如： 用户把来自不一样资源的两个JavaScript行为代码编至同一网页内，而这两个行为代码的变量名相同，这时就有可能出现问题。
　　所以作为查询故障的一个技巧，在出现故障时，用户能够查询一下相同网页中是否存在相同文件名的变量名称。

 

CSS类及id中的命名规则

　　Web开发人员能够经过建立CSS类及id名称并使用这些名称来对divs以及其余的格式页面元素进行标识。对开发人员来讲，在命名从新定义XHTML标记（tags）的CSS selectors时，必须保证其与预约义的标记准确匹配，但就类以及id选择器名称而言，则仁者见仁，智者见智。然而为所欲为的为这些类以及id命名则并非个好的习惯。

直观命名

　　当在设计Web页面以及须要对一个div进行标识的时候，最天然的想法就是使用能够描述元素所在页面位置的词汇来对其命名。
　　例如：top-panel
　　　　　horizontal-nav
　　　　　left-side
　　　　　center-column
　　　　　right-col

　　这些是CSS以及XHTML类和id的有效命名方式。这些词汇简单而且可以令人顾名思义，所以知足了标识页面元素以及相应的CSS样式的须要。

　　但问题是这样的名称同页面内容的特定表达方式相关联。这些命名参考了某种特定页面布局中的页面元素位置，所以在这样的布局以外使用就会显得不合适甚至形成理解混乱。这些命名没有涉及文档内容的结构。所以，下面给出了对CSS类以及ID命名更好的方法。

结构化命名

　　这些是CSS以及XHTML类和id的有效命名方式。这些词汇简单而且可以令人顾名思义，所以知足了标识页面元素以及相应的CSS样式的须要。 这些是CSS以及XHTML类和id的有效命名方式。这些词汇简单而且可以令人顾名思义，所以知足了标识页面元素以及相应的CSS样式的须要。

　　有标记的相关信息都是用来描述文档的结构而不是外观。这样的特色使得咱们能够经过简单的改变CSS的方式来对不一样外观格式下的内容（content）以及标记（markup）进行重用。当你理解这种方式时，很容易就能够发现采用页面位置来为类以及id命名的方式在处理如音频（audio）等外观格式上显得很是不合适。所以，应当根据在文档中的使用目的而非出现位置来对类以及id进行结构化命名。

　　能够按照以下所示的结构化方式来对类以及id名称命名：
　　例如：branding
　　　　　main-nav
　　　　　subnav
　　　　　main-content
　　　　　sidebar

　　这些名字同直观命名方式同样很是易懂，但他们描述了页面元素的做用而非位置。这使得代码更加符合使用纯粹的结构化标记（structural markup）的初衷，即开发人员能够在不改变标记的状况下对各类各样媒体下的显示格式进行处理。

　　即便你不打算在其余的媒体上对Web页面进行格式修改，使用结构化命名方式还能够帮助你在往后的站点升级或从新设计中更为轻松。例如，结构化命名避免了当一个div同id right-column移动到页面左边后所带来的混乱。对div sidebar的采用这样的命名方式就显得更加适当，由于不管它出如今页面的哪一边，这个名字仍然对开发人员来讲直观易懂。

惯例

　　Andy Clarke分析了40份由推崇标准化Web设计理念的开发人员所设计的Web站点的源代码。尽管类以及id名称很不统一，可是仍是发现了一些频繁出现的经常使用名称。这里给出了最经常使用类/id名称的示例列表：

　　例如：header
　　　　　content
　　　　　nav
　　　　　sidebar
　　　　　footer

 

VBScript中的命名规则

 

常数命名规则

　　VBScript 的早期版本不容许建立用户自定义常数。若是要使用常数，则常数以变量的方式实现，且所有字母大写以和其余变量区分。常数名中的多个单词用下划线 (_) 分隔。
　　例如： USER_LIST_MAX 、NEW_LINE

　　这种标识常数的方法依旧可行，但您还能够选择其余方案，用 Const 语句建立真正的常数。这个约定使用大小写混合的格式，并以con”做为常数名的前缀。
　　例如： conYourOwnConstant

变量命名规则

　　出于易读和一致性的目的，请在 VBScript 代码中使用如下变量命名约定：

子类型	前缀	示例
Boolean	bln	blnFound
Byte	byt	bytRasterData
Date (Time)	dtm	dtmStart
Double	dbl	dblTolerance
Error	err	errOrderNum
Integer	int	intQuantity
Long	lng	lngDistance
Object	obj	objCurrent
Single	sng	sngAverage
String	str	strFirstName

变量做用域命名规则

　　变量应定义在尽可能小的做用域中。VBScript 变量的做用域以下所示：

做用域	声明变量处	可见性
过程级	事件、函数或子过程	在声明变量的过程当中可见
Script 级	HTML页面的HEAD部分，任何过程以外	在脚本的全部过程当中可见

变量做用域前缀命名规则

　　随着脚本代码长度的增长，有必要快速区分变量的做用域。在类型前缀前面添加一个单字符前缀能够实现这一点，而不导致变量名过长。

做用域	前缀	示例
过程级	无	dblVelocity
Script 级	s	sblnCalcInProgress

描述性变量名和过程名的命名规则

　　变量名或过程名的主体应使用大小写混合格式，而且尽可能完整地描述其目的。另外，过程名应以动词开始，例如 InitNameArray 或 CloseDialog。

　　对于常用的或较长的名称，推荐使用标准缩写以使名称保持在适当的长度内。一般多于 32 个字符的变量名会变得难以阅读。使用缩写时，应确保在整个脚本中保持一致。例如，在一个脚本或脚本集中随意切换 Cnt 和 Count 将形成混乱。

对象命名规则

　　下表列出了 VBScript 中可能用到的对象命名约定（推荐）：

对象类型	前缀	示例
3D 面板	pnl	pnlGroup
动画按钮	ani	aniMailBox
复选框	chk	chkReadOnly
组合框、下拉列表框	cbo	cboEnglish
命令按钮	cmd	cmdExit
公共对话框	dlg	dlgFileOpen
框架	fra	fraLanguage
水平滚动条	hsb	hsbVolume
图像	img	imgIcon
标签	lbl	lblHelpMessage
直线	lin	linVertical
列表框	lst	lstPolicyCodes
旋钮	spn	spnPages
文本框	txt	txtLastName
垂直滚动条	vsb	vsbRate
滑块	sld	sldScale

 

代码注释规则

　　全部过程的开始部分都应有描述其功能的简要注释。这些注释并不描述细节信息（如何实现功能），这是由于细节有时要频繁更改。这样就能够避免没必要要的注释维护工做以及错误的注释。细节信息由代码自己及必要的内部注释来描述。

　　当传递给过程的参数的用途不明显，或过程对参数的取值范围有要求时，应加以说明。若是过程改变了函数和变量的返回值（特别是经过参数引用来改变），也应在过程的开始部分描述该返回值。

　　过程开始部分的注释应包含如下区段标题。相关样例，请参阅后面的“格式化代码”部分。

区段标题	注释内容
目的	过程的功能（不是实现功能的方法）。
假设	其状态影响此过程的外部变量、控件或其余元素的列表。
效果	过程对每一个外部变量、控件或其余元素的影响效果的列表。
输入	每一个目的不明显的参数的解释。每一个参数都应占据单独一行并有其内部注释。
返回	返回值的解释。

　　请记住如下几点：

• 每一个重要的变量声明都应有内部注释，描述变量的用途。
• 应清楚地命名变量、控件和过程，仅在说明复杂细节时须要内部注释。
• 应在脚本的开始部分包含描述该脚本的概述，列举对象、过程、运算法则、对话框和其余系统从属物。有时一段描述运算法则的假码是颇有用的。

格式化代码

　　应尽量多地保留屏幕空间，但仍容许用代码格式反映逻辑结构和嵌套。如下为几点提示：

• 标准嵌套块应缩进 4 个空格。
• 过程的概述注释应缩进 1 个空格。
• 概述注释后的最高层语句应缩进 4 个空格，每一层嵌套块再缩进 4 个空格。例如：

 '*********************************************************   ' 目的：    返回指定用户在 UserList 数组中第一次出现的位置。   ' 输入：    strUserList():   所查找的用户列表。   '           strTargetUser:   要查找的用户名。   ' 返回：    strTargetUser 在 strUserList 数组中第一次出现时的索引。   '           若是目标用户未找到，返回 -1。   '*********************************************************     Function intFindUser (strUserList(), strTargetUser)       Dim i                     ' 循环计数器。       Dim blnFound        ' 发现目标的标记。       intFindUser = -1       i = 0                     ' 初始化循环计数器。       Do While i <= Ubound(strUserList) and Not blnFound           If strUserList(i) = strTargetUser Then                blnFound = True   ' 标记设为 True。               intFindUser = i   ' 返回值设为循环计数器。           End If           i = i + 1             ' 循环计数器加 1。       Loop   End Function