記得以前大學一年級上C時,課本裡的範例或者光碟的程式都有很詳細的註解
像//......
/*....*/
我想這些東西咱們資工系的人一定不會陌生,我原本以為那是因為那是課本作者才必須這樣寫,好讓大家知道,後來上大四上軟工時記得聽說過台灣的資工系學生documentation很爛,都自以為是不寫註解,使得自己寫的程式只有自己看得懂,別人無法使用變成又重新寫..浪費資源浪費時間,有時候甚至自己寫的程式過個一兩年來看又看不懂...= =我就有這例子= =...(到美國後看自己以前寫的asp都看不太懂...)
沒想到這學期修Java的課,我所有function都可以跑然後都符合規定,結果老師return我作業說,你的程式可以跑沒問題但是你沒寫documentation...
扣2.5分!總分50分.....還好老師很好可以resummit...因為我提早交她提早改是的程式課裡documentation也是她評分標準,不但要在程式裡頭註記每個class在幹嘛還必須在程式最上面寫上你名字,以及有無任何人討論?假如有寫要寫幾個人及他們的名字(外國人非常重視智慧財產權...這點我有血淚的經驗...碩一上時...),以及這程式是否能跑?假如不能跑也要寫能跑到哪...
記得在清大讀資工系助教和同學重視的都是你哪些功能有做到,以及跑有沒有啥問題這邊滿鼓勵你和同學討論,但是當然不能抄程式。記得上學期學Python時,我和美國同學討論程式,偶然看到她的Python code哇靠她幾乎每個地方都有註解這是幹嘛這是幹嘛...我看了就跟她說妳的習慣好好喔,她說這樣我之後要來看也比較好懂。這讓我想到我們的教育好像只注重你做不做得出來,而不是注重你的過程你的想法和自己的點子,還有之後跟別人合作自己要配合的地方。
在美國讀書尤其是讀我們這領域的,discussion課很多,對一般亞洲學生剛來的很不能適應,像已經二年級的我經過第一年殘酷的洗禮和羞辱,現在已經上課也會自動發表自己意見和想法了,但我發現亞洲學生一年級的都很安靜就想到我去年剛來也是這樣...