控件cnpack開發(fā)組成員手冊(cè)

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