作者ric2k1 (Ric)
看板EE_DSnP
标题Re: [问题] 关於written report
时间Wed Jan 23 23:18:45 2008
※ 引述《oker (oker)》之铭言：
: 如果注解已经写得很详细了
: 每个funtion的功能，一些trick的code的解释
: 还有这样设计的理由...等等
: 还是要写written report吗??...
是的.
1. 在 code 里面写太 detailed 的注解, 有时候不是件好事,
一方面可能会让 code 变得有点 messy,
另一方面也会造成 code maintain 上的负担.
2. Written report 还是会比直接看 code 来得 organized 一点.
--
※ 发信站: 批踢踢实业坊(ptt.cc)
◆ From: 59.121.132.15
1F：推 ilway25:report 是主要解释重要的部份, trivial简单的可简略吗?? 01/23 23:36
2F：→ ric2k1:trivial 的部份就 trivial 的带过吧! 01/24 00:02
3F：推 eemingh:唉就是把CODE用中文重写一次吗????????? 01/24 00:40