开发文档的简要模板(范例)

模板

整体概述 系统运行要求 功能介绍

数据库文档 库存放路径 库设计习惯 所有数据内容 数据表 数据视图 关键数据内容 二次开发必看读：view_NewsInfo视图说明

程序源码文档 代码编写习惯 程序文件清单 关键文件清单 函数库 系统管理员信息类库

二次开发 数据库 如何取得指定父目录下所有子目录 如何取得整个Tsys系统数据库中所有栏目下的资源数据 系统功能 如何在系统内核中添加新的管理员权限 如何在右边的树型目录中添加新菜单 其它

 

范例

系统运行要求 　　除ASP Web服务器的一般要求外，本系统还须拥有Script.FileSystem对象权限、以及服务器IE为5.5以上的版本，否则系统将无法正常运行。 功能介绍 　　１无限层资源分类设定 　　２资源的在线视化编辑 　　３统一的资源模板管理 　　４可对指定资源分类设定资源模板 　　５全部资源生成静态文件（按时间、类型进行生成） 　　６资源回收站（回收站内的资源可以求救回） 　　７灵活且强大的资源特性（结合特性实现资源的多重身份） 　　８批量移动资源 （指定ID范围、类别间与类别、时间范围） 　　９资源来源、作者数据规范管理 　　１０资源在线可视化编辑 　　１１方便的文件上传 　　１２数据库基本管理（压缩、备份） 　　１３系统安全（权限细分、管理分组、管理锁定） 　　１４管理员登录唯一限制（同名管理帐户只允许唯一IP使用） 　　１５指定资源生成目录

·数据库文档	TOP
库存放路径 /DataBase/DataBase.Mdb 库设计习惯 数据表名依据表用途以英文相符单词命名，各关键单词首字母大写，如：News（资源数据表）、AuthorList（作者表） 数据表名较长的，则各单词间用"_"符隔开，News_Speciality（资源特性表） 所有视图表一律以"view_"开头标识 字段命名同表命名习惯（详细见各表结构说明） 所有数据内容 数据表 (按字母顺序) Admin（管理帐号员表） Admin（管理帐号员表） 字段名 类型 必填 默认 备注 Id 主键自增 是 　 主键自增 Title 文本(20) 是 　 管理员帐号名称 NickName 文本(50) 是 　 管理员昵称（被用于资源的责任编辑） Pwd 文本(30) 是 　 管理员密码（采用MD5加密） Role 数字 是 　 用户角色类型（见Admin_Role） Lock 数字(字节) 　 0 锁定 0：解锁；1：锁定 AddTime 日期/时间 　 　 添加时间 UpTime 日期/时间 　 　 上次更新时间 LoginTime 日期/时间 　 　 本次登录时间 LastLoginTime 日期/时间 　 　 上次登录时间 LoginCount 数字 　 　 登录次数 FileSysRoot 文本(255) 　 　 绑定文件系统目录 Admin_Role（帐号角色数据表） Admin_Role（帐号角色数据表） 字段名 类型 必填 默认 备注 Id 主键自增 是 　 主键自增 Title 文本(50) 是 　 角色名称 Content 文本(255) 　 　 角色简介 Popedom 文本(100) 　 　 权限列表 ClassPopedom 文本(255) 　 　 栏目权限列表（ClassId,权值&vbCrLf&....） UpTime 日期/时间 　 　 最后更新时间 ClassId 数字 　 　 只允许查看该类别Id的资源 AuthorList（资源作者表） AuthorList（资源作者表） 字段名 类型 必填 默认 备注 Id 主键自增 是 　 主键自增 Title 文本(50) 是 　 作者名称 Content 备注 　 　 作者简介 Email 文本(50) 　 　 作者Email Sex 数字(字节) 　 0 作者性别 BigPhoto 文本(100) 　 　 作者照片 UpTime 日期/时间 　 　 更新时间 AddTime 日期/时间 是 　 添加时间 State 文本(10) 　 　 来自（省份） ClassList（资源分类表） ClassList（资源分类表） 字段名 类型 必填 默认 备注 Id 主键自增 是 　 主键自增 Title 文本(200) 是 　 类别名称 Title2 文本(50) 　 　 类别别名 Parent 数字 　 0 父分类Id UpTime 日期/时间 　 　 最近更新时间 OrderNum 数字 　 1 显示优先值(越大就越靠前) Template 数字 　 0 模板Id Directory 文本(200) 　 　 自定义资源生成目录 ClassUrl 文本(255) 　 　 栏目主页地址 FromList（资源来源表） FromList（资源来源表） 字段名 类型 必填 默认 备注 Id 主键自增 是 　 主键自增 Title 文本(50) 是 　 来源标题 Content 文本(100) 　 　 显示代码 UpTime 日期/时间 　 　 最近更新时间 InsertList（页面内容替换） InsertList（页面内容替换） 字段名 类型 必填 默认 备注 Id 主键自增 是 　 主键自增 Title 文本(50) 是 　 标题 Content 备注 　 　 插入的内容 FileList 备注 　 　 被插入页面列表 StartElement 文本(255) 是 　 起始标签 EndElement 文本(255) 是 　 结束标签 AddTime 日期/时间 　 　 添加时间 UpTime 日期/时间 　 　 更新时间 News（资源数据存放表） News（资源数据存放表） 字段名 类型 必填 默认 备注 Id 主键自增 是 　 主键自增 Class 数字 　 0 资源所属类别Id Title 文本(100) 是 　 来源标题 Url 文本(200) 　 　 跳转链接 Content 备注 　 　 内容 Author 数字 　 　 资源作者 From 数字 　 　 资源来源 Count 数字 　 　 点击 KeyWord 文本(100) 　 　 关键字（可多项,各项间用逗号隔开） Editor 文本(50) 　 　 责任编辑（管理员帐户） Created 数字(字节) 　 0 是否已经生成静态文件 ImgNews 数字(字节) 　 0 是否图片资源 SmallImg 文本(100) 　 　 图片资源小图 BigImg 文本(100) 　 　 图片资源大图 ShortContent 文本(255) 　 　 资源内容摘要 Speciality 文本(100) 　 　 资源特性ID列表 IsChecked 数字(字节) 　 0 资源省核 0:未审 1:已审 Del 数字(字节) 　 0 虚拟删除标记 0:未删除 1:已删除 FilePath 文本(100) 　 　 静态文件路径 AddTime 日期/时间 　 　 添加时间 UpTime 日期/时间 　 　 更新时间 LoginLock（封IP列表） LoginLock（封IP列表） 字段名 类型 必填 默认 备注 Id 主键自增 是 　 主键自增 Title 文本(50) 是 　 IP地址 AddTime 日期/时间 　 　 添加时间 LoginWrongLog（登录失败记录） LoginWrongLog（登录失败记录） 字段名 类型 必填 默认 备注 Id 主键自增 是 　 主键自增 Title 文本(50) 是 　 IP地址 AddTime 日期/时间 　 　 添加时间 News_Speciality（资源特性表） News_Speciality（资源特性表） 字段名 类型 必填 默认 备注 Id 主键自增 是 　 主键自增 Parent 数字 　 　 父类Id Title 文本(50) 是 　 特性名称 Explain 文本(200) 　 　 特性简介 UpTime 日期/时间 　 　 更新时间 News_Template（资源模板表） News_Template（资源模板表） 字段名 类型 必填 默认 备注 Id 主键自增 是 　 主键自增 Title 文本(50) 是 　 模板标题 Content 文本(200) 　 　 模板内容 UpTime 日期/时间 　 　 更新时间 AddTime 日期/时间 　 　 添加时间 数据视图 View_AdminInfo（管理员信息视图） 显示了Admin表中的所有信息及Admin_Role中部份信息。 相关联的表有：Admin,Admin_Role view_AllNewsInfo（所有资源详细数据） 相关联的表有：News,Admin,AuthorList,FromList,ClassList view_NewsInfo（所有资源详细数据，不含被'删除'/未审核'/'未生成的资源'） 相关联的表有：News,Admin,AuthorList,FromList,ClassList 该视图同时也是前台所有资源数据调用所使用的.可称它为"用户接口表",正如括号内所描述,它已过滤了所有不附合要求的数据,因此开发人员无需每次都在Sql的Where处写上烦杂的条件过滤语句,同时也提供了一至的字段出口给调用者，避免了因跟改如News,AuthorList等表结构而不得不对所有的前台程序的修改。 view_NewsInfo2（所有资源详细数据，不含被'删除'/'未审核'的资源） 相关联的表有：News,Admin,AuthorList,FromList,ClassList

·程序源码文档

TOP

代码编写习惯 本系统采有Asp VBscript脚本语言编写，规范如下： 脚本关键字,变量,常数一律首母大写 变量一律先定义后使用 变量名详细定议 Def_IsAutoRemberLoginName. 程序缩进格式编写 所有常用函数功能包装成独立.Asp文件,存放在Include目录中 程序功能模块化/模块页面化 如： News_List.asp/News_Add.asp/News_Mdy.asp Author_List.asp/Author_Mdy.asp <% Select Case Request("Work") ----Case "ClearDustbin" ----Call ClearDustbin() ----Case "SaveMdy" ----Call SaveMdy() ----Case Else End Select %> '/// '//保存修改的资源记录 Sub SaveMdy() ----Dim Id,ClassId,Title,Author,From,KeyWord ----...... End Sub 程序文件清单 关键文件清单 ./Manage/Include/Config.asp [系统主要配制文件] ./Manage/Include/CharFun.asp [字符串操作函数类库] ./Manage/Include/CreateFile_Fun.asp [静态资源文件生成函数] ./Manage/Include/PopedomConfig.asp [系统权限配制类库。需要新增权限将使用本文件] ./Manage/Include/ClassList_Fun.asp [资源分类操作函数。形成当前位置,获得指定类别下的所有子类别等] ./Manage/News_Add.asp [资源编辑页面] ./Manage/News_Mdy.asp [存储资源内容程序页面] ./Manage/Menu.asp [功能目录页面] ./Manage/Library/XTree/Tree.asp [目录树配制Js文件] 函数库 系统管理员信息类库 <% '定义系统管理员信息类 Dim SysAdmin Set SysAdmin=New SYSProedom_Class If Not CBool(SysAdmin.Logined) Then ----'显示当前管理员帐户名称 ---- Response.Write SysAdmin.AdminTitle End If %>

·网友二次开发

TOP

数据库 如何取得指定父目录下所有子目录 <% '取得指定父目录Parent下的所有子目录 Dim Parent ----Parent=10 Response.Write AllChildClass(Parent) '输出结果,例：,23,32,43,54,65,67 %> 如何取得整个Tsys系统数据库中所有栏目下的资源数据 <% '取得指定父目录Parent下的所有子目录 Dim Parent ----Parent=0 Dim Sql ----Sql="Select * From view_NewsInfo Where Class In (" & Parent & AllChildClass(Parent) & ") Order By Id DESC" Dim Rs Set Rs=Conn.ExeCute(Sql) %> 系统功能 如何在系统内核中添加新的管理员权限 一、找到系统管理员权限类库文件 　　Manage/Include/Tkl_SYSProedomClass.asp 二、定义权限变量名 　　Private Podm_ManageDataBase 三、赋于该权限变量数字值做为唯一的权限Id标识 　　 Podm_ManageDataBase=19 四、在“初始化权限列表”中加入该权限变量 　　 Podm_ManageDataBase & ",数据库管理," &_ 五、最后新建一个类属性,开发者通过都获取该属性以得知是否具有此权限（返回为Bool型） 　　 '是否有数据库的权限 　　Public Property Get ManageDataBase() 　　　　'如果当前管理员所属的角是超级管理员,则直接返回True值 　　　　If AdminRoleTitle=defAdminRoleTitle Then 　　　　　　ManageDataBase=True 　　　　　　Exit Property 　　　　End If 　　　　'使用EnoughPopedom函数判断当前管理员的权限列表中是否有此权限的Id值 　　　　ManageDataBase=EnoughPopedom(Podm_ManageDataBase) 　　End Property 六、使用举例：(系统管理员信息类库) 如何在右边的树型目录中添加新菜单 详见树型目录配制文件：Manage/Library/XTree/Tree.Js

 

 

以上资料均摘自网上