大家说说，写程序时除了写注释外还要写哪些文档？

jianlinlong 2002-10-15 06:07:54

帮忙讨论一下。这些文档包括哪些内容。

...全文

26 15 打赏收藏转发到动态举报

写回复

用AI写文章

15 条回复

切换为时间正序

请发表友善的回复…

发表回复

imickey 2002-10-17

打赏
举报

建议看一些软件工程的书，编码可能只占20%或者更少

june37 2002-10-17

打赏
举报

学习！谢谢！

猛禽 2002-10-17

打赏
举报

如果是按CMM/RUP一类的做法,楼上所说的文档,多多益善
如果是按XP的做法,那除了SOURCE,什么都不要,连注释都尽量少

xdspower 2002-10-17

打赏
举报

你参考网上的一些比较好的实际代码，特别是老外的，真的是好的例子！
此外你还要写设计报告的！

gfh21cn 2002-10-17

打赏
举报

找本软件工程书看一看
呵呵
再根据你的实际情况决定需要哪些文档。

Dermao 2002-10-16

打赏
举报

学习

yyfzy 2002-10-16

打赏
举报

《需求分析报告》
《可行性分析报告》
《概要设计说明书》
《数据库设计说明书》
《详细设计书》
《测试报告》
《用户手册》
还要编写“在线帮助”
……

mynameis007 2002-10-15

打赏
举报

一般在每个文件的开头还有该文件的主要功能,函数,作者,更改日志等.

大大怪老张 2002-10-15

打赏
举报

整个软件开发过程都需要有关文档.

楼上的那些都有模板可用.

不过个人认为单独工作的话不必做死,协同合作的话就要按部就班了.

ysh 2002-10-15

打赏
举报

《需求规格书》、《概要设计说明书》、《数据库设计说明书》、《详细设计书》、《测试报告》、《用户手册》......
这些都有国家标准的。

僵哥 2002-10-15

打赏
举报

你怎么想到的当然别人不管，只是告诉别人你是怎样解决问题的。别人要么就使用你的这种方法去容易的解决复杂的问题，或者是看你的解决问题的方法是否正确(这一点很重要)。所以程序不是要为了能写程序而写程序，而是为了能解决问题而写程序。具体的问题具体的方案才有具体的代码，难道你写程序时不是这样做的吗？无可置疑都会是这样的，只是具体的问题的差别。

jianlinlong 2002-10-15

打赏
举报

是不是要写些模块是干什么用的，当时写这些代码是如何想到的这些东西。

僵哥 2002-10-15

打赏
举报

当然最起码的是每个模块的功能等。这最终取决于你的程序的规模，应用范围。比如多人开发，那么有些就要写清楚你的程序是做什么的，具体在哪里做了什么(这是由程序来写文档，一般的话都是先写文档后再写具体的执行程序。)，特别是一些公用的模块，以及对整个程序起着的决定性的模块更是要求相当的明了，还有就是技术性相当强的模块要求更加的细致。不过对于从需求出发做的开发，那考虑的问题的思路就有着相当逆向的编写思维。那样的话，文档就要求是专门的人员来编写，程序所要编写的文档只是些技术性文档和操作的特定规范(这样的规范通常较少甚至没有)。

大大怪老张 2002-10-15