网站首页
本站精华
免费下载
游客:
注册
|
登录
|
会员
|
搜索
|
帮助
LoveUnix
»
行业应用 项目实施
» 请教,阅读别人代码如何编写文档
‹‹ 上一主题
|
下一主题 ››
投票
交易
悬赏
活动
打印
|
推荐
|
订阅
|
收藏
标题: 请教,阅读别人代码如何编写文档
lunarorbit
LU新生
UID 4249
精华 0
积分 1
帖子 2
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 10
注册 2003-12-1
#1
大
中
小
使用道具
发表于 2003-12-24 10:28
资料
个人空间
短消息
加为好友
诸位前辈大家好,小弟要在弄懂一个linux下面大程序(C语言),
想请教如何作文档
小弟是搞电子出身的,从来没学过软件工程方面的知识,
也不知道对于一个规模较大的程序需要有哪些文档来维护,
,以前的时候写的程序都不大,主要是一些在电路板上面
运行的硬件测试程序,因为代码量很小,也不用考虑什么版本的问题,
也不考虑编程习惯,可是最近由于工作需要,我需要看懂一个在
PC上面给linux系统写的免费的音频解码程序,规模挺大的。
自从在论坛里面看了那篇经典的“完全使用GNU/LINUX工作”以后
我也开始在linux下面进行我的学习和工作,现在我只要不调试
硬件的时候我就全在linux系统下面,但是我对于linux了解的只有
一些基本的系统管理和安装软件的知识。对于那个几万行的程序
我看起来真是无从下手,看懂局部可以,但是对于全局感觉还是
无法把握,往往是看懂了这里忘了那里.
于是我感到要是想把握一个别人写出来的大程序,作好
关于该程序的阅读笔记是挺重要的。可是我不知道,在看程序
的时候应该如何记录,我觉得要作一些不同层次的记录,比如
说算法层次的和模块层次的,但是却不知道在作这些记录时
应当根据一些什么样的原则来把握。
请大家指教,谢谢。
threehair
荣誉斑竹
UID 27
精华
78
积分 3034
帖子 5716
活跃指数 0
LU金币 2093 个
LU金条 0 个
阅读权限 200
注册 2003-9-17
#2
大
中
小
使用道具
发表于 2003-12-24 11:13
资料
个人空间
短消息
加为好友
如果你仅仅想理解别人的程序写的笔记。哦的经验是掌握整个软件的大框架,然后逐步加深,逐层深入,从主流程到函数再到每个函数的具体实现
╭⌒╮ ╭⌒╮╭⌒╮
╱◥███◣╭╭ ⌒╮
︱田︱田 田|
关门,上锁,钥匙已生锈。
世事静方见,人情淡始长!
carol
荣誉斑竹
幻想懒王++
UID 1859
精华
66
积分 5139
帖子 10006
活跃指数 32
LU金币 2596 个
LU金条 0 个
阅读权限 200
注册 2003-11-7
#3
大
中
小
使用道具
发表于 2003-12-24 11:23
资料
个人空间
短消息
加为好友
偶刚上手的时候,也是一推代码要读,
偶自己一边读,一边画了个流程图,就都搞懂了~~
无双
荣誉斑竹
天才猪
UID 4
精华
84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自 杭州
#4
大
中
小
使用道具
发表于 2003-12-24 12:05
资料
个人空间
主页
短消息
加为好友
差不多这个样子
软件中有概要设计与详细设计
这两个的文档很重要
概要就是知道系统分几个模块
实现原理是什么
各模块间接口是什么
详细就是重要函数的接口是什么
一般来说概要设计最重要 知道了软件的框架后就可以进行维护了
如果是写别人的维护文档的话 写到这步也差不多了
不要问我结果 我只研究过程与思路
无双客栈
yuehui
LU新生
UID 721
精华 0
积分 6
帖子 12
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 10
注册 2003-10-17
#5
大
中
小
使用道具
发表于 2003-12-24 13:43
资料
个人空间
短消息
加为好友
同意无双的建议,我觉得你看得程序可能没有相关的文档,只能从程序本身去理解了。可以采用无双的建议,从结构框架开始,逐步细化,相当于反向工程了,呵呵!
lunarorbit
LU新生
UID 4249
精华 0
积分 1
帖子 2
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 10
注册 2003-12-1
#6
大
中
小
使用道具
发表于 2003-12-24 15:50
资料
个人空间
短消息
加为好友
谢谢诸位前辈的回复,小弟感觉受益匪浅,所以我觉得
我还是根据几位的建议,按照大家说的,先开始一边看
一边写文档,因为小弟以前没写过这类东东,所以在上手
写之前肯定不会把所有的问题都想到,我还是边练边学吧
,到时候有问题了再来向大家请教。
祝各位圣诞快乐
[广告]
记录自己的思想火花,留住每日的技术积累,尽在拥有属于自己独立域名的博客。
无双
荣誉斑竹
天才猪
UID 4
精华
84
积分 5863
帖子 11390
活跃指数 0
LU金币 4248 个
LU金条 0 个
阅读权限 200
注册 2003-9-16
来自 杭州
#7
大
中
小
使用道具
发表于 2003-12-24 22:20
资料
个人空间
主页
短消息
加为好友
先知道那个软件大概是什么写的
结构怎样
分几个模块
然后再看就方便多了
不要问我结果 我只研究过程与思路
无双客栈
[广告]
记录自己的思想火花,留住每日的技术积累,尽在拥有属于自己独立域名的博客。
刹那芳华
LU新生
UID 7767
精华 0
积分 4
帖子 8
活跃指数 0
LU金币 2006 个
LU金条 0 个
阅读权限 10
注册 2003-12-30
#8
大
中
小
使用道具
发表于 2003-12-30 15:50
资料
个人空间
短消息
加为好友
侯捷的那本剖析MFC结构的书中讲到了他的剖析经验,可作参考
[广告]
记录自己的思想火花,留住每日的技术积累,尽在拥有属于自己独立域名的博客。
投票
交易
悬赏
活动
LoveUnix
专项技术区
> AIX -IBM UNIX
> 其他UNIX & Linux
> i5 (AS400) & IBM大机
> PC Server & HPC
> 存储设备
> 备份软件
> 网络 & 安全
> 编程开发 & Rational
> DB2 & Informix
> ORACLE等数据库
> 中间件技术
行业综合区
> 职业咨询 前程无忧
> 培训认证 行业入门
> 行业应用 项目实施
> 产品信息 商务交流
> Free download下载
交流灌水区
> 蓝色太平洋
> 墨香雅韵
> 论坛建设
> 博客专区
当前时区 GMT+8, 现在时间是 2008-12-4 13:49
乐悠LoveUnix论坛-京ICP备05005823号
Thanks to
Discuz!
© 2001-2007 Power by
LoveUnix.net
Processed in 0.053721 second(s), 6 queries , Gzip enabled
TOP
清除 Cookies
-
联系我们
-
乐悠LoveUnix
-
Archiver
界面风格
----------
Discuz! 5 Default
新DISCUZ风格
控制面板首页
编辑个人资料
积分交易
公众用户组
好友列表
升级个人空间
基本概况
流量统计
客户软件
发帖量记录
论坛排行
主题排行
发帖排行
积分排行
在线时间
管理团队
管理统计