标题: 详细设计的代码文档, 请教!!!
无双
荣誉斑竹
Rank: 14Rank: 14Rank: 14Rank: 14
天才猪



UID 4
精华 84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自 杭州
 
发表于 2003-11-11 23:08  资料  个人空间  主页 短消息  加为好友 
DROP TABLE S_SWIP; //上网IP
CREATE TABLE S_SWIP
(
STARTIP VARCHAR(20) NOT NULL,
ENDIP VARCHAR(20) NOT NULL,
constraint PK_S_SWIP primary key(STARTIP)
)
;

DROP TABLE P_FPPRINT //发票打印
;
CREATE TABLE P_FPPRINT
(
ZDM VARCHAR(20) NOT NULL,
DTZDM VARCHAR(30) NULL
)
;

DROP TABLE S_CDSJF //超短时不计费
;
CREATE TABLE S_CDSJF
(
CDTIME NUMERIC(3) NOT NULL,
constraint PK_S_CDSJF primary key (CDTIME)
);

SQL表可以使用表格的形式写出来吧
不用直接写SQL语句的
一般如下
表名
列名 值类型 默认值 可空 说明
差不多上面这样的样子 我觉得比较直观 不懂SQL的人也可以看出来

有界面的东西没有做过
我意见是
介面写上调用模块和被调用模块 这样知道这个界面会在哪里使用 怎样使用
不然单独的还是不知道做什么用的





不要问我结果 我只研究过程与思路
无双客栈
顶部
threehair
荣誉斑竹
Rank: 14Rank: 14Rank: 14Rank: 14


UID 27
精华 78
积分 3034
帖子 5716
活跃指数 0
LU金币 2093 个
LU金条 0 个
阅读权限 200
注册 2003-9-17
 
发表于 2003-11-12 00:00  资料  个人空间  短消息  加为好友 
原来你们也用南天的AUTOBRANCH awkard.gif





╭⌒╮ ╭⌒╮╭⌒╮
╱◥███◣╭╭ ⌒╮
︱田︱田   田|
关门,上锁,钥匙已生锈。
世事静方见,人情淡始长!
顶部
珂珂
LU幼天使
Rank: 2
飞舞的绿色精灵



UID 236
精华 4
积分 197
帖子 378
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 20
注册 2003-9-29
 
发表于 2003-11-12 09:13  资料  个人空间  短消息  加为好友 
QUOTE(雨人 @ 2003-11-11 21:09:48)
keke,上面是全部的文档吗?
你把文档的目录贴出来,我看看
(上面的文档好像是概要设计的多一点)
我到是做过概要设计和详细设计;

这个才是我的概要设计模板,不过我要在上面做修改,可是一点头绪也没有 sad.gif sad.gif


1 概述
1.1 编写目的
简要说明编写本概要设计说明书的目的,指出读者对象。
1.2 术语和缩写
简要说明本概要设计说明书中涉及的专门术语、容易引起歧义的概念、关键词缩写及其他需要解释的内容。例:
术语 描述性定义
Internet: 英特网
Intranet: 内部网
1.3 参考资料
以列表或排序的方式给出重要的参考资料的名称、文档标识号、版本号,作者、单位等信息。例:
序号 文件名 文件标识号 发表日期 出版单位或作者


2 系统构架设计
2.1 系统总体结构图及其约束和假定
对整个系统体系统结构作一个描述。
1. 描述系统设计中最主要的约束,说明系统是如何来适应这些约束的。
2. 如果系统跟其它外部系统交互或者依赖其它外部系统提供一些功能辅助,那么,要求描述与本系统有交互的软件类型以及这样导致的约束。
3. 实现的语言和平台。
4. 简要地描述你的想法思路,为什么要采取这样的设计等等。
2.2 技术构架设计
2.3 软件功能结构设计
此处给出整个系统和各个子系统的总体功能结构图及必要的文字说明。
3 应用系统设计
3.1 设计原则
1、根据功能细分,使构件或(对象)具有相对的独立性,可以组装在任何子系统的功能模块中。
2、一个对象的基本要素包括四大要素
对象标识-给对象一个可以辨识的名称,要求具有唯一性。
主实体-对象主要操作的数据库表结构。
动作过程-即对象对数据的处理过程和表达方式。
I/O关系-即对象的动作过程中所牵涉到的其他数据实体。
3、一个对象既可以用存储过程实现(纯SERVER程序, 不牵涉到人机界面)或纯CLIENT程序(仅在CLIENT上显示结果,一般用于查询)实现,也可用存储过程与CLIENT程序相结合的方式实现。
3.2 公用构件或对象设计
给出关于公用构件或对象的名称、功能、输入、处理、输出信息以及被公用的信息。
3.3 功能模块设计
3.3.1 功能模块1的设计
此处给出功能模块的名称、功能、输入、处理、输出等设计信息。
3.3.2 功能模块2的设计
3.4 公用构件或对象与功能模块的关系




功能模块 公用构件或对象 对应关系



4 接口设计
4.1 外部接口
此处给出新的系统与其他应用系统之间的接口设计内容。
4.2 内部接口
此处给出新系统内部系统之间或子系统内部模块之间的接口设计。
5 开发环境的设计
5.1 开发环境设计
此处给出新系统的开发环境要求,具体包括网络、服务器、数据库、前台、开发工具等的软硬件设计内容。
5.2 编码规范
此处可以给出进行详细设计和代码编制时所遵循的命名规则和编码规范以及代码组织的设计内容。也可引用其它已文档化的编码规范。
6 运行环境设计
此处给出新系统的实际运行环境要求,具体包括网络、服务器、数据库、前台、测试工具等的软硬件设计内容。
7 追溯表



概要设计章节 需求规格说明书章节





那些美丽的小鱼,它们睡觉的时候也睁着眼睛。不需要爱情,亦从不哭泣。它们是我的榜样。
顶部
无双
荣誉斑竹
Rank: 14Rank: 14Rank: 14Rank: 14
天才猪



UID 4
精华 84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自 杭州
 
发表于 2003-11-12 09:17  资料  个人空间  主页 短消息  加为好友 
你是设计的还是什么
如果是设计软件
那就先把系统分成模块

概要主要就是内部模块间接口和对外接口





不要问我结果 我只研究过程与思路
无双客栈
顶部
珂珂
LU幼天使
Rank: 2
飞舞的绿色精灵



UID 236
精华 4
积分 197
帖子 378
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 20
注册 2003-9-29
 
发表于 2003-11-12 09:23  资料  个人空间  短消息  加为好友 
QUOTE(threehair @ 2003-11-12 00:00:03)
原来你们也用南天的AUTOBRANCH awkard.gif

本来我们有自己的产品的,但是客户选择了他们的autobranch做基础平台,所以我们现在做的中间业务也要用他们的

sad.gif glare.gif glare.gif glare.gif





那些美丽的小鱼,它们睡觉的时候也睁着眼睛。不需要爱情,亦从不哭泣。它们是我的榜样。
顶部
珂珂
LU幼天使
Rank: 2
飞舞的绿色精灵



UID 236
精华 4
积分 197
帖子 378
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 20
注册 2003-9-29
 
发表于 2003-11-12 09:27  资料  个人空间  短消息  加为好友 
我就是不明白到底是怎么回事所以才发愁的。
领导只说让我设计详细设计和概要设计的模板,而且越细致越好,可是我前面只参加过一个项目,而且那个项目的详细设计和概要设计写的很简单,而且业务流程什么的都比较清楚。
可是现在的这个我就被弄晕了,不知道该怎么写了





那些美丽的小鱼,它们睡觉的时候也睁着眼睛。不需要爱情,亦从不哭泣。它们是我的榜样。
顶部
[广告] 记录自己的思想火花,留住每日的技术积累,尽在拥有属于自己独立域名的博客。
无双
荣誉斑竹
Rank: 14Rank: 14Rank: 14Rank: 14
天才猪



UID 4
精华 84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自 杭州
 
发表于 2003-11-12 09:37  资料  个人空间  主页 短消息  加为好友 
概要是写模块间接口与外部接口
详细是写系统的功能的实现
也就是每个功能的实现

可以参考我上面给的那文档啊
我那时写时是一个函数一个功能
把主要函数功能与算法都写出来





不要问我结果 我只研究过程与思路
无双客栈
顶部
[广告] 记录自己的思想火花,留住每日的技术积累,尽在拥有属于自己独立域名的博客。
珂珂
LU幼天使
Rank: 2
飞舞的绿色精灵



UID 236
精华 4
积分 197
帖子 378
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 20
注册 2003-9-29
 
发表于 2003-11-12 09:53  资料  个人空间  短消息  加为好友 
我刚才咨询了一下同事我们的详细设计要分两中方式去写,一种是根据交易描述的,需要把整个交易流程,界面包括域对应的字段什么的都描述清楚,另外一种是根据功能点来描述的,这种针对功能点的详细设计描述要做些什么?





那些美丽的小鱼,它们睡觉的时候也睁着眼睛。不需要爱情,亦从不哭泣。它们是我的榜样。
顶部
[广告] 记录自己的思想火花,留住每日的技术积累,尽在拥有属于自己独立域名的博客。
无双
荣誉斑竹
Rank: 14Rank: 14Rank: 14Rank: 14
天才猪



UID 4
精华 84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自 杭州
 
发表于 2003-11-12 10:19  资料  个人空间  主页 短消息  加为好友 
交易流程相当UML中的序列图了吧
就是表达一个操作中有什么对象参与
调用的接口是什么
这是动态交互过程

根据功能就是静态的
把每个接口有什么功能给写出来





不要问我结果 我只研究过程与思路
无双客栈
顶部
[广告] 记录自己的思想火花,留住每日的技术积累,尽在拥有属于自己独立域名的博客。
珂珂
LU幼天使
Rank: 2
飞舞的绿色精灵



UID 236
精华 4
积分 197
帖子 378
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 20
注册 2003-9-29
 
发表于 2003-11-12 10:27  资料  个人空间  短消息  加为好友 
谢谢无双,我先想想总结一下,然后有不懂在请教你

多谢啊!!!! rose.gif rose.gif rose.gif





那些美丽的小鱼,它们睡觉的时候也睁着眼睛。不需要爱情,亦从不哭泣。它们是我的榜样。
顶部
无双
荣誉斑竹
Rank: 14Rank: 14Rank: 14Rank: 14
天才猪



UID 4
精华 84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自 杭州
 
发表于 2003-11-12 10:34  资料  个人空间  主页 短消息  加为好友 
OK
其实在这方面我也不是很清楚D

规范的大公司都有自己的文档模板和编写标准
要是能拿到就好了





不要问我结果 我只研究过程与思路
无双客栈
顶部
qinxj
技术专家
Rank: 14Rank: 14Rank: 14Rank: 14



UID 1117
精华 1
积分 166
帖子 328
活跃指数 0
LU金币 5406 个
LU金条 0 个
阅读权限 200
注册 2003-10-29
 
发表于 2003-11-12 13:57  资料  个人空间  短消息  加为好友  添加 qinxj 为MSN好友 通过MSN和 qinxj 交谈
以前的结构化编程的详细设计,相信大家都写得不少,也有很多不错得模板存在。但是当我转向对象化编程之后,真的不知道如何写出一个好的详细设计了,尤其是跟代码同步的问题更是难于解决!

某有一个想法,不知道大家以为如何?
1、在编码的时候把注释写好一点,在函数的前面如下写:
// 函数原型:
// 功能说明:
// 入参:
// 出参:
// 返回值:
// 设计考虑:
// 修改人:
//
2、在详细设计的文档中,以功能来划分模块,主要着重流程图、状态图、对象交互等,这部分与传统的方法大同!

按照这种方法,在写代码的同事,1已经完成。
对于2,可以在写代码之前完成,如果时间不允许的话,在代码完成之后完成也不难。

主要思想就是:讲具体的细节留给代码注释完成,详细设计只注重一个个功能模块的架构!





合久必分、分久必和!
顶部
 



当前时区 GMT+8, 现在时间是 2008-11-22 22:38
乐悠LoveUnix论坛-京ICP备05005823号

Thanks to Discuz!  © 2001-2007    Power by LoveUnix.net
Processed in 0.058797 second(s), 6 queries , Gzip enabled

清除 Cookies - 联系我们 - 乐悠LoveUnix - Archiver