作者WalkingIce ( 杀手哥吉拉 13)
看板Programming
标题Re: [请益] 程式该怎麽越写越好呢
时间Sun Sep 6 03:43:34 2009
※ 引述《realmeat (真肉)》之铭言：
: ※ 引述《amppp (Monte-Carlo)》之铭言：
: 我的目标则是
: 程式码当中不使用到一行注解, 就能让别人了解你写的程式
: 要做新的东西, 需要运用原本所写的功能
: 只要把档案搬过去就能work, 做到模组化
: 程式写到现在 感觉只是对不同的资料进行处理
: 看最底层只是 许许多多的指令, 按照自己设计的动作排序好
: 没有啥需要被证明的
: 对我来说真正的课题 则是在程式码的可读性以及可移植上才是重点
最近在看 code 的时候突然有一种经验
刚好那一份程式码没有注解，其实它写得很好
当我深入下去看的时候大多数都看得懂
只是看完後我会想说：如果他加了一行注解告诉我这段程式码在干嘛
或许会让我看 code 时候更快
就像看报纸的时候，绝大多数的报导只看标题就知道需不需要认真看
前一段时间遇到一个 bug
也因为它是一个 bug，所以整个演算法是有瑕疵的
却因为它没有注解，我猜不透它到底是想做行为 A 却没做好
或是这段程式码产生的行为 B 在这个情况下不适用
(也就是说这一小块程式码没错，但是放到某些条件下使用时就会发生问题)
A 或 B 的修法不一样，如果选错了方向
即使现在把 bug 修掉了，也难保未来不会变成一个隐性的 bug
让我花很多时间的反倒是去猜原作者到底想要的是什麽
这时候就会很感慨：「如果有一行短短的注解就好了～」 :-)
--
随手关电脑，救救北极熊
--
※ 发信站: 批踢踢实业坊(ptt.cc)
◆ From: 61.57.131.211
1F：→ adrianshum:这种想法我是认同的，可惜大部份人写的218.103.237.217 09/06 21:10
2F：→ adrianshum:comment 都只是用来解释程式的 flow218.103.237.217 09/06 21:10
3F：→ adrianshum:而不是如你所说提出重点。218.103.237.217 09/06 21:10
4F：推 ricky906:这样的comment才值得写到source code里.. 114.32.138.98 09/06 23:34
5F：→ ricky906:code都已经够长了.额外的注解能免则免.. 114.32.138.98 09/06 23:35
6F：→ ricky906:我觉得原po需要的应该是一份设计文件 114.32.138.98 09/06 23:37
7F：推 yoco315:技术文件+1 问题是 99% 的公司没这东西 XD 118.160.110.8 09/07 00:02
8F：推 softwind:越短的code越需要 doc ... but ...118.166.117.240 09/07 01:08
9F：→ softwind:有台湾公司把doc视为产出吗?118.166.117.240 09/07 01:09
10F：推 creeds:注解是礼节，或许自己不需要但还是有比没好 140.127.47.149 09/23 15:04