详细设计的代码文档，请教！！！ - 行业应用项目实施 - LoveUnix -- 最强AIX小机技术论坛,UNIX,Linux,存储,数据库,中间件,开发,管理 -- 蓝色的IBM技术天堂 --bbs.LoveUnix.net

LoveUnix » 行业应用项目实施 » 详细设计的代码文档，请教！！！

‹‹ 上一主题 | 下一主题 ››

47 1/4 1 2 3 4 ››

LU幼天使

Rank: 2

飞舞的绿色精灵

UID 236
精华 4
积分 197
帖子 378
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 20
注册 2003-9-29

大中小

发表于 2003-11-11 09:04 资料个人空间短消息加为好友

代码设计要与文档并行，这次开发领导希望我们的文档可以尽量细化，所以想在这里找一些关于详细设计的文档模板做参考，希望大家可以有好的建议给我。

谢谢大家咯！！！

那些美丽的小鱼，它们睡觉的时候也睁着眼睛。不需要爱情，亦从不哭泣。它们是我的榜样。

荣誉斑竹

Rank: 14

Rank: 14

Rank: 14

Rank: 14

天才猪

UID 4
精华 84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自杭州

大中小

发表于 2003-11-11 09:09 资料个人空间主页短消息加为好友

概要是与语言无关定义了系统的结构与接口及接口功能
详细是与语言相关定义了一种语言的详细实现
其中包括每个主要函数的算法流程而不只是接口函数
格式如下

我只是记忆的)
函数说明
输入
输出
算法
流程

自己的理解大概是这样的你们那边应该有文档模板可以参考吧

不要问我结果我只研究过程与思路
无双客栈

荣誉斑竹

Rank: 14

Rank: 14

Rank: 14

Rank: 14

天才猪

UID 4
精华 84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自杭州

大中小

发表于 2003-11-11 09:09 资料个人空间主页短消息加为好友

模板偶没有

不要问我结果我只研究过程与思路
无双客栈

技术专家

Rank: 14

Rank: 14

Rank: 14

Rank: 14

UID 1117
精华 1
积分 166
帖子 328
活跃指数 0
LU金币 5406 个
LU金条 0 个
阅读权限 200
注册 2003-10-29

大中小

发表于 2003-11-11 09:21 资料个人空间短消息加为好友

添加 qinxj 为MSN好友

通过MSN和 qinxj 交谈

下面的链接能够给你一些有用的模板：
http://www.51cmm.com/SoftDocuments/No016.htm

不过有时候写得太复杂也没有什么好处，对于详细设计只需要对每个功能描述清楚就足够了!概要设计就是总体设计，要把握系统的全局!

本人主张在代码里面加注释的方式来补充详细设计。

合久必分、分久必和!

LU幼天使

Rank: 2

飞舞的绿色精灵

UID 236
精华 4
积分 197
帖子 378
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 20
注册 2003-9-29

大中小

发表于 2003-11-11 09:23 资料个人空间短消息加为好友

收到！！

谢谢！！

那些美丽的小鱼，它们睡觉的时候也睁着眼睛。不需要爱情，亦从不哭泣。它们是我的榜样。

荣誉斑竹

Rank: 14

Rank: 14

Rank: 14

Rank: 14

天才猪

UID 4
精华 84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自杭州

大中小

发表于 2003-11-11 10:37 资料个人空间主页短消息加为好友

我觉得详细只要对接口的逻辑描述清楚就可以了

写太详细了

后面修改类具体实现时(内部函数非public)还要修改文档
那不很累

不要问我结果我只研究过程与思路
无双客栈

[广告] 记录自己的思想火花，留住每日的技术积累，尽在拥有属于自己独立域名的博客。

技术专家

Rank: 14

Rank: 14

Rank: 14

Rank: 14

UID 1117
精华 1
积分 166
帖子 328
活跃指数 0
LU金币 5406 个
LU金条 0 个
阅读权限 200
注册 2003-10-29

大中小

发表于 2003-11-11 12:25 资料个人空间短消息加为好友

添加 qinxj 为MSN好友

通过MSN和 qinxj 交谈

主要是要明白写详细设计的目的，是为了以后便于别人或者自己对代码进行维护工作。如果这是一个大的项目的话，详细设计从根本上来说还是越详细越好。但是如果代码的注释写得好的话，详细设计就可以相对简单一点。

合久必分、分久必和!

[广告] 记录自己的思想火花，留住每日的技术积累，尽在拥有属于自己独立域名的博客。

荣誉斑竹

Rank: 14

Rank: 14

Rank: 14

Rank: 14

UID 27
精华 78
积分 3034
帖子 5716
活跃指数 0
LU金币 2093 个
LU金条 0 个
阅读权限 200
注册 2003-9-17

大中小

发表于 2003-11-11 17:21 资料个人空间短消息加为好友

QUOTE(qinxj @ 2003-11-11 12:25:45)

主要是要明白写详细设计的目的，是为了以后便于别人或者自己对代码进行维护工作。如果这是一个大的项目的话，详细设计从根本上来说还是越详细越好。但是如果代码的注释写得好的话，详细设计就可以相对简单一点。

同意。

╭⌒╮ ╭⌒╮╭⌒╮
╱◥███◣╭╭ ⌒╮
︱田︱田田|
关门，上锁，钥匙已生锈。
世事静方见，人情淡始长！

[广告] 记录自己的思想火花，留住每日的技术积累，尽在拥有属于自己独立域名的博客。

荣誉斑竹

Rank: 14

Rank: 14

Rank: 14

Rank: 14

天才猪

UID 4
精华 84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自杭州

大中小

发表于 2003-11-11 17:34 资料个人空间主页短消息加为好友

不是还有文档评审吗

如果文档不评审的话

那什么写当然看自己了

但是如果有评审
那就要写得比较详细
让别人一看就知道做的方法

不要问我结果我只研究过程与思路
无双客栈

[广告] 记录自己的思想火花，留住每日的技术积累，尽在拥有属于自己独立域名的博客。

LU幼天使

Rank: 2

飞舞的绿色精灵

UID 236
精华 4
积分 197
帖子 378
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 20
注册 2003-9-29

大中小

发表于 2003-11-11 17:53 资料个人空间短消息加为好友

是要评审的。所以我做的尽量细致，可是我发现一个问题就是，好象很多内容包括了，操作手册的东西，那样的话是不是就不对了啊。

那些美丽的小鱼，它们睡觉的时候也睁着眼睛。不需要爱情，亦从不哭泣。它们是我的榜样。

荣誉斑竹

Rank: 14

Rank: 14

Rank: 14

Rank: 14

天才猪

UID 4
精华 84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自杭州

大中小

发表于 2003-11-11 19:28 资料个人空间主页短消息加为好友

操作手册是不包含的
详细设计只是写这个软件的设计

也就是这个程序的实现各部分的实现算法

不要问我结果我只研究过程与思路
无双客栈

LU幼天使

Rank: 2

飞舞的绿色精灵

UID 236
精华 4
积分 197
帖子 378
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 20
注册 2003-9-29

大中小

发表于 2003-11-11 19:39 资料个人空间短消息加为好友

我想到要写流程的描述，可是我们领导要我把详细设计里加入整个交易的操作流程，就是从输入域直到交易做完的所有流程，包括数据是怎么传输的都写上

这样对吗？

我怎么看怎么觉得象操作手册了

那些美丽的小鱼，它们睡觉的时候也睁着眼睛。不需要爱情，亦从不哭泣。它们是我的榜样。

47 1/4 1 2 3 4 ››

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

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

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