博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
思想:分析文档是什么(8)
阅读量:5992 次
发布时间:2019-06-20

本文共 494 字,大约阅读时间需要 1 分钟。

  hot3.png

思想:分析文档是什么(8)
开发人员为什么要写分析文档呢?这是一个很值得思考的问题。我认为可以写也可以不写,得看具体情况。如果需求文档写得很清楚,开发人员一看就知道应该怎么做,那么分析文档就可以不写。或者分析的内容都能溶入到代码的注释中去了,那么分析文档也没有必要写,因为有些项目不如直接看代码来得快。
注释就是为了能更好的理解代码,分析文档也是为了更好的理解代码,这样我们清楚了,分析文档的功能和注释是一样的,只是做了一些注释不能做的事情,比如说清楚整个代码结构、目录层次等。当然我的建议是能写好注释最好,分析文档能少写就少写。另外数据库设计部份有些也要放在分析文档里,或者直接放在一个sql文件里。
现在我们理解了分析文档本质上也是代码的一部份,它和注释一样并不参与执行,但是能更好的理解和维护。分析文档里要吧写总体的分析思路,这会对我们将来重新回头来看这个项目会有很大的好处。当然为了减少在分析文档上所花的时间,我们可以写一个简单的文本文件。在迭代过程中也容易维护这个文本文件。
2012.1.11

转载于:https://my.oschina.net/zao/blog/38878

你可能感兴趣的文章
SpringCloud 总览
查看>>
PostgreSQL构建通用标签系统
查看>>
Docker集群管理系统Kubernetes
查看>>
DB2数据库用SQL求时间差
查看>>
shell中变量的查看和删除
查看>>
VSAN故障-数据传输速度极慢
查看>>
tar命令语法(-[cxt],-[zj],-v,-f)
查看>>
连接12cR2 PDB报错ORA-28040/ORA-01017
查看>>
Exchange 2013 cu16补丁更新
查看>>
Netty In Action中文版 - 第一章:Netty介绍
查看>>
关于Segmentation fault (core dumped)
查看>>
nginx + PHP (FastCGI) 高性能服务器部署
查看>>
nginx启动与停止
查看>>
unsquashfs的部署和用法
查看>>
Saltstack配置管理功能模块-haproxy
查看>>
shell 脚本检测密码,5次错误则停止
查看>>
PIX配置手册二(telnet和ssh)
查看>>
MySQL高可用之MHA
查看>>
python的一些基础的知识
查看>>
centos6.5突然没有Yum命令
查看>>