哈,上来自喷一句

中山野鬼 发布于 2014/12/02 13:03
阅读 574
收藏 0

现在发现自己,不先写说明,就不知道怎么写代码了。

先得定义概念术语。然后确定功能边界。组织数据结构,后面才是分割,细化,具体化逻辑。

代码好些,定义难。。。。

补充说一下我个人的说明文档的结构。反正不是给客户看的,是给开发用的。所以和传统的“软件设计说明文档有比较大出入”。权当讨论借鉴一下。

1、模块说明(主要介绍模块的名称,模块的任务,用于区别其他模块,但不描述与其他模块的关联关系)

2、术语定义(描述本模块中涉及的概念术语。这个现在发现越来越重要。这个不能确定一个具体设计的边界,但能确定一个具体设计的中心)

3、数据组织

4、接口说明

实际各种逻辑,针对我写的c语言,接口说明,就是对函数的解释了。不过只是对外部可访问的接口进行描述。

必要下,会对一些内部的STATIC函数进行说明。

哈,啥是必要下,前半个月,有天晚上,凌晨1点多,大脑已经有点慢了,急着想把一个文件数据处理的小功能写完,针对文件,有三个指针,已经读的行,已经写的行,下一个要跳转的行位置。写了20分钟,总是对不齐,于是,写文本流程。把文本流程放到源码文件中,依次再实现。而说明文档中留下的这些文字,就是“必要下,一些内部的STATIC函数的说明”。

加载中
0
OSC闲人
OSC闲人
写这些可以减少返工量,能较准确的预估时间
0
中山野鬼
中山野鬼

引用来自“成熟的毛毛虫”的评论

写这些可以减少返工量,能较准确的预估时间
系统别说规模有多大,模块超过2个,三个轮着玩,往往从一个坑里爬出来就找不到北了。通常我得把设计说明再理一边,才知道下面的工作内容。哈。
0
朱宏青
朱宏青

肯定要先有需求定义 再写代码啊

很多时候 需求定义会花去大部分时间 而代码只是小部分

如果写代码中途发现问题 那就是需求定义的时候不够清楚 不够深

当然 代码架构要在需求定义的时候就要有大致方向 别写代码的时候乱哄哄的

0
雨翔河
雨翔河
必须的啊,有文档有详细的说明,这不就好写吗。编码的时间是占少数的,多的时间得花在这上面。
0
乌龟壳
乌龟壳
深刻学习了,谢谢。
0
请叫我赵小宝
请叫我赵小宝
前辈的经验贴,不错!
0
hlevel
hlevel
能否 开源一篇出来让大家学习一下呢?开源不止软件的,重要的是精神与经验分享.
0
店长强力推荐
店长强力推荐
啊哈,手游行业,代码就是项目的唯一描述。
0
修改登录密码
修改登录密码

这是做架构设计。架构设计好了相当于走对了方向。架构做好了  换哪个码农上都可以。

就不至于出现一个人写的代码 其他人不知怎么修改和维护的情况了

0
d
damao
术语定义似乎容易被忽视,结果讨论时经常有鸡同鸭讲的感觉
返回顶部
顶部