asp开发规范.doc

asp开发规范 一、单页编写规范： 切记页面要分模块来写： 第一模块：接收参数。[有可能从不同页面提交到同一个页面；也可能出现两个表单项以哪个优先的处理。 第二模块：定义全局变量。 第三模块：写处理代码(尽量将代码都包含到函数中，详见页面附注一。)。——到此asp代码主要部分完成。 第四模块：纯html代码，利用储存在全局变量中的值来生成页面。 第五(注意)：要在页面头部写清页面逻辑。(如何接收、处理。) 优点：便于维护。模块独立，便于重复使用到类似页面。 二、全站文件构建规范： 1.工程接手后，先观看静态页，掌握逻辑及浏览顺序。 2.抽取页面中被重复利用到的地方做成嵌入文件。 3.抽取头文件、尾文件，及左侧菜单栏，做成嵌入文件。 4.划分页面结构，做出模板文件。——以后制作中就copy它，然后就可直接制作。 注意：不要急于编写页面，除非你接手的是一项小工程，或者用户需求已经非常清楚确定并且不会再更改，否则，保持页面代码的可读性是非常重要的！(当你面对大返工时，你的心情如何？先对潜在的危险考虑一下吧！) ——因为我们每个人都对自己写的代码非常明白，而都比较难于读懂别人写的代码。并且，由于客户需求的变化，修改甚至推翻原有设计是比较常见的事。所以要注意在编写代码时注意让后来者快速读懂，并便于修改。][至少要在页面头部加上注释，在代码中间重要的部分，也有必要加一些说明性注释。] 我们所作的一切仅仅是为了：增加可移植可重用性、使逻辑清楚，便于维护、 适应用户需求的改变，并尽快完成，减少无用功。 附注一：第三模块编写说明。《ASP页面编写结构》 1.先写注释 2.写嵌入文件。 3.写大块的ASP代码（从COM中取出的） ——注意：复杂页面，尽量将不同COM的操作封装在独立的函数里； ——函数结尾有一句调用，后面页面中直接读取函数处理完的数据(已被赋给全局变量) ——调用函数前，对页面入口参数进行合法性检验。 附注二：第四模块编写说明。《Html代码部分需要注意的》 1)最好不使页面的asp代码和html代码混杂在一起，——感觉比较混乱。 2)通过获取全局变量的数据得到asp的处理结果。 3)关于客户端javascript： 表单提交前要进行合法性检验。写在 1、一些经常要用到的程序，除了写成函数处，一般要单独出来，以便共用。如错误（主要用于提交页面的非法参数）处理。可以写成一个AlertError函数（主要是输出一段JavaScript），考虑到函数的通用性，设定的参数有：JavaScrip弹出警告框的说明文字（如：名字不能为空等）；页面location.href的变量（如果为空，则window.history.back()）。 2、写ASP的时候，注意累积一些东西，这样对以后工作效率的提高会有不少的帮助。 如：数据的提交及处理是最常见的，一般的做法是每一个新的工程都要重新做。其实，只要在第一个工程里花多一点的时间，你就可以做一个标准的可以重复利用的数据提交处理程序。这个程序建议是在一个页面内完成的，不要把提交前台和后台分开，分开的想法是代码的可读性高，但是，只要把增加、修改、删除都封装成函数，代码的可读性一样很高，而且不必反复切换页面去寻找页面间传替的变量。程序先是读取所有的参数。其中active参数用于确定操作而调用函数add(), update(), delete(), show()（修改时用于显示旧数据）等。注意这个程序不要有太多的输入框，但同时最好又包括了各种输入框类型，还有不要用任何花巧的页面设计等，这样重复利用起来才是最简单的。 3、HTML代码尽量直接写在页面上，而不要用Response.Write输出大量的HTML代码。 因为Response.Write在DW等网页编辑器中是不可见的，这不利于美工的修改。 4、不要在页面上传递的数据库内的数据。 但是很多人却这么做了，导致的后果是很明显的，就是对方可以修改你的数据而导致数据的错误。正确的做法是只传递数据库内数据的关健字，然后在处理页面再一次从数据库中select出数据。不要因为这种做法比较麻烦而不去做。 当然，如果你传递的数据只是用于页面的输出的话不在讨论范围。 5、尽量减少session的使用，可以的话只用session记录用户名。 因为session太占资源了。我试过一个用户用了几十个session，结果初始化session的值就用了10多秒。 6.HTML代码中如果内联元素%=过多,建议在编写脚本时使用html调试，但最终交付使用时，最好把其连续成连接字符串用response.write一次调用！起效率反而要高的！ 特别是对使用非常频繁的asp页面文件。 7.保证整个asp页面的输出能按标准的htmlhead/headbody/body/html基本来设计结构，