网站开发编码规范文档.docVIP

编码规范文档 以下内容，尽量做到，特别标蓝地方极为重要。标蓝的地方做到并不复杂，不耽误什么时间，开发时间也就增加一点点。只要开发时候注意一下就行。但是回报是非常大的。 前期严格规范，建立开发习惯，好处如下： 能给后期维护带来极大方便。特别换人或者自行成立部门接手维护，熟悉代码需要花一定的时间，好的代码，接手人员可以节约的时间成本相当多。 能避免或改善以后很多比较麻烦问题： 可以提高客户访问的加载速度； 节省网站运行时候的服务器资源开销（不好的代码，消耗内存、CPU和访问线程，可以多出好几倍的开销，问题会在访问人数巨大时候会呈现）； 特别能避免客户使用不同系统不同浏览器访问，可能出现的兼容和出错问题。 3、就算在开发时候回头排除bug，清晰的代码都会省很多时间 一）源程序文件结构： 每个程序文件应由标题、内容和附加说明三部分组成。 （1）标题：文件最前面的注释说明，其内容主要包括：程序名，作者，功能简要说明等，必要时应有更详尽的说明（将以此部分以空行隔开单独注释）。 （2）内容控件注册等函数应放在内容部分的最后，类的定义按private、protected、pubilic、__pubished的顺序，并尽量保持每一部分只有一个，各部分中按数据、函数、属性、事件的顺序。 （3）附加说明：文件末尾的补充说明，如参考资料等，若内容不多也可放在标题部分的最后。 二）编辑风格： 1）缩进：缩进以Tab为单位，一个Tab为四个空格大小。全局数据、函数原型、标题、附加说明、函数说明、标号等均顶格书写。 2）空格：数据和函数在其类型，修饰（如__fastcall等）名称之间适当空格并据情况对齐。关键字原则上空一格，不论是否有括号，对语句行后加的注释应用适当空格与语句隔开并尽可能对齐。 3）对齐：原则上关系密切的行应对齐，对齐包括类型、修饰、名称、参数等各部分对齐。 4）空行：程序文件结构各部分之间空两行，若不必要也可只空一行，各函数实现之间一般空两行。 注释：对注释有以下三点要求： A、必须是有意义； B、必须正确的描述了程序； C、必须是最新的。 注释必不可少，但也不应过多，以下是四种必要的注释： 标题、附加说明； 函数说明：对几乎每个函数都应有适当的说明，通常加在函数实现之前，在没有函数实现部分的情况下则加在函数原型前，其内容主要是函数的功能、目的、算法等说明，参数说明、返回值说明等，必要时还要有一些如特别的软硬件要求等说明； 在代码不明晰或不可移植处应有少量说明；及少量的其它注释。 三）命名规范： 坚持采用匈牙利变量命名惯例，所有标识符一律用英文或英文缩写，杜绝采用拼音，标识符中每个单词首字母大写，缩写词汇一般全部大写，只在必要时加“_”间隔词汇。 四）文件规范 1. html, css, js, images文件均归档至系统开发规范约定的目录中; 2. html文件命名: 英文命名, 后缀.htm. 同时将对应界面稿放于同目录中, 若界面稿命名为中文, 请重命名与html文件同名, 以方便后端添加功能时查找对应页面; 3. css文件命名: 英文命名, 后缀.css. 共用base.css, 首页index.css, 其他页面依实际模块需求命名.; 4. Js文件命名: 英文命名, 后缀.js. 共用common.js, 其他依实际模块需求命名. 五）html书写规范 1. 文档类型声明及编码: 统一为html5声明类型; 编码统一为, 书写时利用IDE实现层次分明的缩进; 2. 非特殊情况下样式文件必须外链至…之间;非特殊情况下JavaScript文件必须外链至页面底部; 3. 引入样式文件或JavaScript文件时, 须略去默认类型声明. 4. 引入JS库文件, 文件名须包含库名称及版本号及是否为压缩版, 比如jquery-1.7.1.min.js; 引入插件, 文件名格式为库名称+插件名称, 比如jQuery.cookie.js; 5. 所有编码均遵循xhtml标准, 标签 属性 属性命名 必须由小写字母及下划线数字组成, 且所有标签必须闭合; 属性值必须用双引号包括; 6. 充分利用无兼容性问题的html自身标签, 比如span, em, strong, optgroup, label,等等; 需要为html元素添加自定义属性的时候, 首先要考虑下有没有默认的已有的合适标签去设置, 如果没有, 可以使用须以”data-”为前缀来添加自定义属性，避免使用”data:”等其他命名方式; 7. 语义化html, 如 标题根据重要性用h(同一页面只能有一个h1), 段落标记用p, 列表用ul, 内联元素中不可嵌套块级元素; 8.