CnPack開發組成員手冊作者：周勁羽(zjy@)CnPack開發組設計組項目管理員類別：項目文檔VCnPack開發組成員手冊作者：周勁羽(zjy@)CnPack開發組設計組項目管理員類別：項目文檔V2002.09.142005.01.13一、前首先，歡迎您來到CnPack開發組的大家庭！正如您所看到的，CnPack的開發是一項龐大而艱巨的工作，直到現在仍在起步階段。CnPack開發組也是一個自由和開放的組織，每一位自愿加入的成員都在用自己的辛勤勞動來換取CnPack的一次次進步，在推動CnPack向前邁進的同時，也推動著整個CnPack開發團隊的成長和每一個成員的進步！我們真誠地希望，每一個加入開發組的成員都可以在開發團隊中感受到溫暖與和諧，并通過積極合作、團結互助、學習進步，逐漸成長為真正優秀的程序員和設計師！也許您還是一位沒有太多開發經驗的新手，也許您以前還沒有過類似的團隊開發經驗，來到開發組后，不知道自己該做和能做些什么，我希望這份文檔可以幫助您更快地熟悉整個開發環境，融入到開發團隊中來。CnPack的管理員信箱是：master@，如果您在開發中有任何建議和問題，都可以與管理員聯系。CnPack不僅要做最優秀的開發包，同樣也要建立最優秀的開發團隊。我們相信，在我們的不懈努力下，CnPack開發組一定能成為最優秀的自由軟件開發團隊之一！（文檔中使用的鏈接如果無效，大多數內容都可以從開發網站上找到二、新成員的準備工作我想您在決定加入CnPack時，已經對它有一定認識了，不過我仍然建議您抽點時間來閱讀一下項目的基本文檔。如果您下載了CnPackCVS源碼包，可以在Doc/Project目錄下找到一些項目文檔，如《CnPack開發方案》等。CnPack的開發網站是：，上面有很多關于CnPack的信息和資料，當然我想您一定很熟悉了：在開發組內部，大量使用郵件列表來進行交流。也許您習慣了使用論壇，對郵件列表這種交流方式還不適應，但實踐證明，對開發團隊而言，郵件列表是一種更為有效的方式。通常，在您申請加入時，管理員會將您加入到郵件列表中，如果沒有，請與管理員聯系。CnPack開發組內部交流使用郵件列表：bbs@，發到該信箱的郵件會自動轉發給每一位成員，而成員對該郵件的回復也會自動通過列表再發給其它成員。要加入在開發組內部，大量使用郵件列表來進行交流。也許您習慣了使用論壇，對郵件列表這種交流方式還不適應，但實踐證明，對開發團隊而言，郵件列表是一種更為有效的方式。通常，在您申請加入時，管理員會將您加入到郵件列表中，如果沒有，請與管理員聯系。CnPack開發組內部交流使用郵件列表：bbs@，發到該信箱的郵件會自動轉發給每一位成員，而成員對該郵件的回復也會自動通過列表再發給其它成員。要加入該郵件列表，只需要向bbs-subscribe@發一封郵件并回復確認信就可以了。如果您是新成員，建議您寫一封郵件發到列表，并簡單地介紹一下自己，讓其它成員對您有個認識。郵件列表是一個相對封閉的討論組，您在開發中有任何建議和問題都可以通過它來請求幫助，或用它來發布消息。要注意的是，郵件列表是有長度限制的，如果有大文件需要發送，請將文件上傳到項目匿名空間（見后），再通過郵件列表通知大家。除了郵件列表，開發組成員還可以在QQ群上進行在線交流。CnPack開發組QQ群的號碼是：359682，人數上限100人，目前也開通了IIIII群，號碼分別為1623654618283718除了郵件列表，CnPack仍然保留了項目開發論壇。論壇主要是面向用戶和支持者的，如消息發布、用戶調查、Bug反饋等，當然也會有一些技術討論和交流。項目的開發論壇可以從項目網站上登錄，我同樣建議到論壇上注冊一下，并在有時間時上去逛逛：開發組使用的FTP空間：。在這里您可以找到很多有用的工具、文檔和源碼，如果您有什么好東西愿意讓大家共享，也可放到上面，FTP上傳帳號請詢問管理員。注意不允許放未經授權的軟件（也就是D版）等。對一個網上協同開發項目來說，版本控制系統的作用是巨大的。CVS（并行版本控制系統）保存了對項目源碼每一次改動的記錄，和改動的一些注釋。在任何時候，我們都可以找到倉庫中任何文件的任何版本，并可將自己的工作成果提交進去。當前CnPack使用共創軟件聯盟提供的CVS服務器，開發組幾乎所有的文檔和代碼都存放在上面。關于CVSCnPack源碼包中Doc/Project里的《CVS通常，在您加入開發組后，項目管理員或其它成員會找機會與您在線或用郵件交流。開發組的對外成員名單可在開發網站上看到，網站管理員還會每月將最新的內部名單發到郵件列表，建議您將他們的聯系方式收藏一下，特別是您所在小組的負責人、開發成員等。當然，由于工作原因，管理員可能會比較忙，您也可以主動與其它成員聯系，或通過郵件列表來交流。在一個開發團隊中，成員之間的經常交流是非常有必要的。有時候，開發組還會通過MSN通常，在您加入開發組后，項目管理員或其它成員會找機會與您在線或用郵件交流。開發組的對外成員名單可在開發網站上看到，網站管理員還會每月將最新的內部名單發到郵件列表，建議您將他們的聯系方式收藏一下，特別是您所在小組的負責人、開發成員等。當然，由于工作原因，管理員可能會比較忙，您也可以主動與其它成員聯系，或通過郵件列表來交流。在一個開發團隊中，成員之間的經常交流是非常有必要的。有時候，開發組還會通過MSN或其它方式舉行在線會議，同城市的成員還將有不定期的聚會。CnPack現在已經有一部分開發文檔和源代碼了。開發組對源代碼的規范要求是很嚴格的，有的程序員寫代碼比較隨意，建議新成員在開始投入工作前花點時間閱讀CVS中的源代碼和設計文檔，特別是所在小組的代碼和設計框架。一個優秀的程序員編寫的代碼絕對是格式規范、結構嚴謹的，細心和負責是最起碼的要求。規范的代碼格式和適當的注釋對其它閱讀代碼的人非常有幫助，希望每個成員都能注意到這一點，將個性和創意體現到最終作品中去，而不是代碼格式上。CnPack源碼包的Doc目錄下，有詳細的文檔、代碼書寫規范，Doc/Templates目錄下還有一些文檔和代碼的模板，建議您抽空熟悉一下。三、開始自己的工作很多新成員在加入開發組后，可能會找不到什么可做的，或是在等待管理員為自己分配任務。事實上，網上協同開發的自由軟件項目，與傳統的公司的團隊開發仍存在很大的CnPack這個自發組織的團隊來說，管理是松散的，沒有人會強迫你要做些什么，或不做些什么。成員并不象在軟件公司一樣，付出自己的勞動并從公司獲得報酬。在這里，大家是在為一個共同的理想而貢獻自己的聰明才智和努力，而我們收獲的是自己的成長、同道的友誼、最終成功的自豪和在為理想奮斗的過程中不斷挑戰極限、超越自我的樂趣。如果您習慣了由主管來安排工作，在加入開發組后，您的第一個問題將是：“我能為開發組做些什么？”在開發組中，自由是每個成員的權利，同時也是義務。開發組沒有等級森嚴的層層管理，成員必須自己考慮工作內容和計劃安排，主動去完成力所能及的事情。閱讀一下CnPack的各種項目和設計文檔，和當前的完成狀況比較，看有哪些自己可以出力的地方；根據自己的經驗和設想，看看開發工作有哪些做得不夠之處；根據自己的特長，看看開發包還有什么可以增加的功能和內容；與管理員和其它成員聯系，聽聽他們有什么需要幫助的地方；瀏覽開發組當前的任務列表，看看有哪些自己可以勝任的任務；測試一下已有的代碼，看看和設計目標有什么出入，是否存在錯誤，是否可以更加完善……這些都是新成員可以做到的工作，也是快速融入開發團隊的有效方法。在找到自己可以勝任的工作之后，建議您不要馬上就動手。通常，合理的計劃和安排會有效地提高工作效率。一些準備工作有時是必要的，如果是編寫代碼，建議先抽點時間設計一下代碼的框架，參考一些類似的代碼是怎樣實現的，對關鍵的技術先進行試驗等等。CnPack對平臺兼容性支持要求很強，設計時還要考慮到不同編譯器、操作系統、運行環境的支持等。等到胸有成竹后再正式開工，工作成果也會更為漂亮。CnPack在找到自己可以勝任的工作之后，建議您不要馬上就動手。通常，合理的計劃和安排會有效地提高工作效率。一些準備工作有時是必要的，如果是編寫代碼，建議先抽點時間設計一下代碼的框架，參考一些類似的代碼是怎樣實現的，對關鍵的技術先進行試驗等等。CnPack對平臺兼容性支持要求很強，設計時還要考慮到不同編譯器、操作系統、運行環境的支持等。等到胸有成竹后再正式開工，工作成果也會更為漂亮。CnPack開發組這個大家庭，我希望每一位成員都能感受到集體的溫暖。幫助他人是一種高尚的品德，我們鼓勵成員之間的交流和互助，協同他人完成工作的能力同樣重要。照道理開發組中從事設計工作的成員都不會來看這份入門級的文檔了：)不過我仍想寫上幾句自己的淺薄經驗和看法，供正在成長的成員參考。設計并不是一件簡單的工作，CnPack的設計者們正在用自己的聰明才智構建一套完整的結構體系，從整個開發包的設計理念，到每一個細節部分的處理，都要在一個統一思想的指導下進行。無序的開發，最終出來的產品是粗糙的，大家都希望CnPack最終能成為一個真正優秀的作品，我也希望每位成員的工作都能盡量少走彎路，并希望大家都能體會到設計的重要性，努力鍛煉自己這方面的能力。在軟件發展到今天這個階段以后，大型項目的開發遠遠不是少數人可以完成的。一個好的程序員并不一定是合格的管理員和導師，怎樣使自己身邊的程序員快速成長起來，小弟也非常希望哪位前輩有以教我。四、獲得幫助沒有人是全能的，怎樣用最快的方法獲得有效的幫助也是一項技能。通常，當我們在開發中遇到困難時，可以通過以下一些方式來尋求幫助：之所以將這種方式放在第一步，是因為其實很多問題都是可以在Delphi的在線幫助MSDN中找到答案的，如果愿意，甚至可以通過閱讀VCL源碼來尋求答案。我們鼓勵成員盡量不要養成依賴別人的習慣，因為獨立解決問題的能力一種優秀的素質。同樣，互聯網是一件工作利器，大家可能都知道大富翁論壇和CSDN吧。大富翁的離線數據庫和全文搜索包含了大量常見問題的解答和技術文章，合理地利用這些資源往往會事半功倍。網上有著豐富的源碼和技術資料，開發組也會收集和整理一些有參考價值的文檔和代碼，通常管理員和小組負責人還會針對具體的開發任務進行更細致的整理和維護。如果在開發時遇到難題，也可以參考這些資料來解決。在這份文檔的最后，列出了一些有價值的資料可供參考。前面幾點其實都是自己去尋找解決方案的途徑，而CnPack的開發往往牽涉到很多系統底層方面的技術，這些技術往往沒有或很難找到現成的答案。這時可以通過郵件列表或開發論壇向組內其它成員求助，讓大家一起來解決這個問題，同時解決之后也可做為開發組的技術財富。往會事半功倍。網上有著豐富的源碼和技術資料，開發組也會收集和整理一些有參考價值的文檔和代碼，通常管理員和小組負責人還會針對具體的開發任務進行更細致的整理和維護。如果在開發時遇到難題，也可以參考這些資料來解決。在這份文檔的最后，列出了一些有價值的資料可供參考。前面幾點其實都是自己去尋找解決方案的途徑，而CnPack的開發往往牽涉到很多系統底層方面的技術，這些技術往往沒有或很難找到現成的答案。這時可以通過郵件列表或開發論壇向組內其它成員求助，讓大家一起來解決這個問題，同時解決之后也可做為開發組的技術財富。在CnPack開發組中，項目管理員絕對是每一位成員的“公仆”。不管您在開發或者工作、生活中遇到什么困難或是需要幫助，都可以與管理員聯系和交流。管理員感謝大家為CnPack所做的一切，也真誠地希望開發組中的每一位成員都能夠在這里獲得快樂和滿足！五、開發包設計開發規范關于CnPack的設計開發規范，在《CnPack開發方案》中已經定義很詳細了，這里重復提到，目的只想再次申明它的重要性。這份手冊只簡單介紹一些更新過的規范和較重要的東西，詳細的內容參見《CnPack開發方案》和下面提到的其它文檔。CnPack源碼包的Doc目錄下存放有所有的文檔，Doc/Templates目錄則保存有全部的文檔模板和源代碼模板，成員可自己查閱。我已經不知多少次提到這份規范了，這里再提一次，CnPack的代碼規范使用由開發組成員RiceBall兄修改的《Delphi代碼標準文檔》。該文檔”Delphi編碼規范.htm”在CnPack源代碼包的Doc/Templates目錄下找到。開發包目前使用KOL附帶的一個幫助文件生成器自動從源代碼中生成HTML格式的幫助文檔，關于在代碼中注釋的方法，同樣可在規范文檔目錄中找到。在規范目錄和模板目錄下，您可以找到編寫文檔時所需要遵循的規定和模板。原則上，開發組要求所有內部、正式文檔都應該用這些模板來編寫。六、開