帮助文档的数据库结构

简介:   自然框架一直没有完整的帮助文档,只是有几个简单的示例。这个就是差距呀,那么帮助文档要怎么写呢?有工具可以自动生成,但是总感觉自动生成的一点都不好用,自己都看不懂。既然要弄文档,那么弄出来的文档就应该能够让大家看着方便,能够看明白是怎么回事。

 

  自然框架一直没有完整的帮助文档,只是有几个简单的示例。这个就是差距呀,那么帮助文档要怎么写呢?有工具可以自动生成,但是总感觉自动生成的一点都不好用,自己都看不懂。既然要弄文档,那么弄出来的文档就应该能够让大家看着方便,能够看明白是怎么回事。

 

  MSDN是一种标准的帮助文档格式吧,只是我不大会看,或者说看着很头痛。学习jQuery,看了jQuery的chm的文档,结构还可以基本可以看懂。于是就想按照jQuery的chm文档的结构来做一个。但是已考虑细节就发现不行。jQuery的文档只有一种,那就是方法。没有属性、事件、委托等。但是自然框架里有这些呀,不弄出来就不够完善。

 

  于是有回过头来看看msdn。这里参照了吴旗娃的分页控件的帮助文档的格式,加了一些自认为可以增加阅读性的东东。弄出来了下面的数据表结构。

 

      

 

【2月7日 修改】 

  栏目名称:就是帮助文档了。

  栏目分类:共用函数、数据访问、分页控件、基础控件、元数据控件、页面基类等。

  帮助的分类:一般用法,类、委托、枚举,属性、事件、方法,等。

  详细介绍:就是详细说明了,这里侧重jQuery的chm的形式。

  参数详细:一个方法可能会有多个参数,所以单独做了个表,一对多。

  示例详细:一个方法也可以有多个示例。

 

  基本就是这样,栏目是大分类,栏目分类是中分类,都是一级的。帮助的分类是小分类n级的。详细介绍就是树叶了。

 

  看到dudu在过年的时候都没有休息,真的是佩服呀。

 

相关文章
|
数据库
Google Earth Engine(GEE)——全球树木异体测量和树冠结构(Tallo)数据库
Google Earth Engine(GEE)——全球树木异体测量和树冠结构(Tallo)数据库
353 1
|
SQL 缓存 分布式数据库
【赵渝强老师】达梦数据库的线程结构
达梦数据库采用单进程、多线程结构,利用对称服务器架构实现高效资源利用与可扩展性。其核心线程类型包括监听线程(管理客户端连接)、I/O线程(处理数据页读写)、工作线程(执行数据操作)、调度线程(定时任务管理)和日志刷新线程(确保REDO日志刷盘)。通过合理分工与同步机制,达梦数据库实现了高性能与稳定性。视频讲解进一步详细介绍了各线程的功能与协作方式。
439 1
【赵渝强老师】达梦数据库的线程结构
|
存储 SQL NoSQL
【赵渝强老师】达梦数据库的逻辑存储结构
本文介绍了达梦数据库的存储结构,包括逻辑和物理存储两部分。逻辑存储结构由数据库(Database)、表空间(Tablespaces)、段(Segments)、簇(Cluster)和页(Page)组成。数据库是最大逻辑单元,包含所有表、索引等;表空间由数据文件组成,用于存储对象;段由簇构成,簇包含连续的数据页;页是最小存储单元。文中还提供了查询表空间、段和页大小的SQL语句,并附有视频讲解和示意图。
584 7
|
数据库
生成数据库结构文档
生成数据库结构文档
|
数据管理 关系型数据库 MySQL
数据管理服务DMS支持MySQL数据库的无锁结构变更
本文介绍了使用Sysbench准备2000万数据并进行全表字段更新的操作。通过DMS的无锁变更功能,可在不锁定表的情况下完成结构修改,避免了传统方法中可能产生的锁等待问题。具体步骤包括:准备数据、提交审批、执行变更及检查表结构,确保变更过程高效且不影响业务运行。
2492 2
|
SQL 存储 缓存
【赵渝强老师】达梦数据库的内存结构
本文介绍了达梦数据库管理系统的内存结构,包括内存池、缓冲区、排序区和哈希区。内存池分为共享内存池和运行时内存池,能够提高内存申请与释放效率,并便于监控内存使用情况。缓冲区涵盖数据缓冲区、日志缓冲区、字典缓冲区和SQL缓冲区,用于优化数据读写和查询性能。排序区和哈希区分别提供排序和哈希连接所需的内存空间,通过合理配置参数可提升系统效率。文内附有具体配置示例及视频讲解,帮助用户深入理解达梦数据库的内存管理机制。
546 0
|
存储 SQL 安全
【赵渝强老师】达梦数据库的物理存储结构
本文介绍了达梦数据库的存储结构及各类物理文件的作用。达梦数据库通过逻辑和物理存储结构管理数据,包含配置文件(如dm.ini、sqllog.ini)、控制文件(dm.ctl)、数据文件(*.dbf)、重做日志文件(*.log)、归档日志文件、备份文件(*.bak)等。配置文件用于功能设置,控制文件记录数据库初始信息,数据文件存储实际数据,重做日志用于故障恢复,归档日志增强数据安全性,备份文件保障数据完整性,跟踪与事件日志辅助问题分析。这些文件共同确保数据库高效、稳定运行。
752 0
|
Oracle 关系型数据库 数据库连接
|
存储 关系型数据库 MySQL
|
存储 关系型数据库 MySQL
MySQL数据库——InnoDB引擎-逻辑存储结构(表空间、段、区、页、行)
MySQL数据库——InnoDB引擎-逻辑存储结构(表空间、段、区、页、行)
694 7

热门文章

最新文章