作者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