※ 引述《[email protected] (風起鷹揚)》之銘言： : ※ 引述《lxb ()》之銘言： : : 這樣想吧, ptt 的維護隊伍已經在前線開發上付出了很多, : : 而我們這些小站台除了受惠外, 有點餘力就不妨做一下 documents. : : 說不定這樣子 ptt 的維護隊, 可以更專心地解決我們提出的問題. : : 各方面要擇取本身的優勢, 合作才會比較順. : : 像我這邊就是較多留意到小站台會關心的地方, 同時也有一定的開發能力, : : 所以我不怕自己菜, 就留獨到理解, 而先提出想法給大家參考. : : 其他站台也可以做到不同的貢獻的, 有時, 單單是發表 source code 中 : : 理解不到的地方, 也可以刺激到討論, 有助於蒐集 FAQ. : 我之前曾在 source code 裡面，用 javadoc 那種方式來寫註解 (硬寫的 XD 見 : docs/proto/) 當時的想法是，我幫我看懂的 code 註解一下，之後的人就不必重 : 新去理解 (當然太 detail 或是已經很 trivial 的東西就不必了)。不過後來好像 : 只有我在寫，我也一段時間沒碰了，所以沒新東西 :p : (我這裡指的文件都是指開發人員需要看的部分。) 　　我覺得開發上所需要的document，並不是註解或者像javadoc那 些東西可以解決的。除了一些本身比較古怪的code，ptt的程式並不 算難看懂了。 　　真正需要的是一個跨程序跨模組的說明文件。舉個例，水球系統 ，在哪個程序觸發啟動，哪個程序編輯訊息，哪個程序收信息，水球 資料放在哪裡，以怎樣的格式，整個流程是怎樣？其實不少功能都分 佈在不同檔案不同函數裡，而且運作方式也不容易理解，跟蹤程式流 程和理解其運作方法就花了大部份時間，真正動手修改相較之下反而 十分簡單。所以我覺得獨立的說明文件對開發最有幫助，程式裡的註 解次之。 -- 作者 Starfish (海星) 看板 SYSOPS-chat 標題 [閒聊] 報到 時間 Sun Apr 11 22:24:18 2004 ─────────────────────────────────────── hihi :) --

※ 發信站: 香港地(hkday.net) ◆ From: 218.254.198.186