一. 背景介绍
有时我们在维护一个软件时,发现原有的代码没有注释,只好硬着头破慢慢研究,有时我们要实现页面显示哪些数据,打开数据库,字段个个都是字母,没有一个备注,还得问这个字段是什么意思有木有！此时我们心里肯定不是滋味,这样工作量无形的增大了,因为要费脑去研究逻辑,去猜这个字段是什么,回头想想曾几何时我们自己也这么干过,代码一写而过,曾来不注释,所以在实际项目开发中,良好的代码注视,不仅可以清晰的了解编程思路, 而且二次开发时,带给别人方便,予人方便,积累口德嘛！
二. 关于RyanDoc For SqlServer 1.0 版
首先我们要了解数据库几个基本概念,服务器,数据库,表,视图,存储过程,触发器,函数,参数,脚本。
它们是包含关系:
1.服务器>数据库>表>(字段,脚本)。
2.服务器>数据库>视图>(字段,脚本)。
3.服务器>数据库>存储过程>(参数,脚本)。
4.服务器>数据库>触发器>(所在表,脚本)。
5.服务器>数据库>函数>(表函数或标量函数,参数,脚本)。
本软件正是结合了以上元素，并以树形结构展示，很清晰，很明了，针对不同的元素显示不同的内容
服务器：显示服务器名,数据库名及个数。
数据库：显示当前版本,数据库大小,路径,表,视图,存储过程等信息,可修改表或视图或存储过程的描述
表:显示表名,表字段、脚本信息,可修改表名和字段描述。
视图:显示视图名,字段、脚本信息,可修改视图名和字段描述。
存储过程:显示存储过程名,参数、脚本信息,可修改存储过程名和参数描述。
触发器:显示存触发器名,所属表、脚本信息,可修改触发器名和参数描述。
函数:显示函数名,是标量函数还是表函数、参数、脚本信息,可修改函数名和参数描述。
支持数据库版本：SqlServer 2000/2005/2008。
软件相关图片如下:
1.
2.
3.
4.
下载地址：http://www.globalryan.net
安装前请确保系统已经安装了.netframework3.5
