作者tylpk (tylpk)
看板Programming
标题Re: [请益] 程式该怎麽越写越好呢
时间Wed Sep 23 07:39:57 2009
※ 引述《H45 (!H45)》之铭言:
: ※ 引述《realmeat (真肉)》之铭言:
: : 我的目标则是
: : 程式码当中不使用到一行注解, 就能让别人了解你写的程式
: 程式码只能描述程式要做的事情,无法描述程式为什麽要做这些事。
: 描述程式码运作的原理与原因必须写在注解或外部文件
: 如果没有写这些额外的说明
: 就算其他人看懂程式每一个步骤,也没有办法完全理解其意义
: 举例而言:
举一个发生在我身上的例子好了
我有一个写了快两年的程式
因为那是我自己开发的
而为了开发这个程式必须先看相关的标准(DICOM)
为了怕别人不想花时间看第三章的相关部份
印象中我程式里面比较重要的地方都会写上注解
不然每个 ECG 仪器厂商的资料都不一样
别人不一定知道那些 sample 排列及还原的方式
(应该吧,手边没有留那些 source code?)
离开那家公司也快一年半了
前两个礼拜
部门的小主管打电话来问我问题
因为我在图书馆看书没接到
隔天回电时
他才说本来是想问我相关问题
後来已经在注解里找到答案了
坦白说
当时的心情真的是很爽
真是不枉费我写程式以来保持的好习惯呀 ... XD
尤其自己年纪大了
自己的程式更是想到就写注解
即使从该 function 的注解就可以知道用途
我还是会在呼叫的地方再写一次
我可不想以後想修改自己的程式
还要回头想老半天
时间是很宝贵滴 ~
--
※ 发信站: 批踢踢实业坊(ptt.cc)
◆ From: 114.45.220.4
1F:→ superGA:嗯... 不写注解 比较能够提升身价(误)140.119.164.131 09/24 23:30
2F:→ opman:不用写code,出一张嘴比较能够提升身价吧. 219.80.137.72 09/25 15:10
3F:→ ykjiang:你是在该公司身价无法提高才离职的吗? 203.70.99.166 09/25 20:42