P5EE的編碼規(guī)則有哪些

這篇文章主要講解了“P5EE的編碼規(guī)則有哪些”，文中的講解內(nèi)容簡(jiǎn)單清晰，易于學(xué)習(xí)與理解，下面請(qǐng)大家跟著小編的思路慢慢深入，一起來(lái)研究和學(xué)習(xí)“P5EE的編碼規(guī)則有哪些”吧！

　　Perl版本

　　我們是在perl5.005_03上編寫所有代碼的。也許有一天我們應(yīng)該利用以下perl5.6的特性。不管怎樣，所有代碼應(yīng)該在perl5.005_03以及后續(xù)版本上都能運(yùn)行。P5EE所有的核心代碼都在perl5.005_03和perl5.6.0上測(cè)試過，雖然現(xiàn)在P5EE用在perl5.6上比較多。

　　文檔

　　所有的模塊文檔都應(yīng)參照模塊模板文件中的POD例子來(lái)撰寫，解釋模塊的方法，目的，用途和每個(gè)帶有名字，描述，輸入，輸出，受影響因素等信息的公用API。文檔中，如果需要返回一個(gè)數(shù)組或哈希表的引用，要記錄數(shù)組的大小(包括恰當(dāng)?shù)孛枋雒總€(gè)元素都是什么)和哈希表中每個(gè)鍵的名字。如果是復(fù)合數(shù)據(jù)結(jié)構(gòu)的話，盡量描繪出合適的結(jié)構(gòu)。另外，在文檔中還要記錄出返回?cái)?shù)據(jù)是什么類型的數(shù)值。是整型，還是一段HTML代碼，還是一個(gè)布爾值?所有命令行程序的選項(xiàng)都要使用命令行程序樣本文件中的代碼來(lái)記錄。每個(gè)有效的方法，switch結(jié)構(gòu)等等都要被記錄，連同方法的描述，目的，程序如何使用。不要嘗試對(duì)不同目的的程序使用相同的選項(xiàng)。對(duì)于所有的WEB程序，應(yīng)當(dāng)在程序注釋段中說(shuō)明功能，目的和使用。任何外部文檔，命令行程序和模塊的文檔都要寫成POD樣式。這樣的話，我們就可以把它們通過多種pod2xxx的轉(zhuǎn)換器轉(zhuǎn)換成各種格式的其他文檔。POD不是一種正規(guī)的標(biāo)簽語(yǔ)言，它只是一種可以讓文檔非常容易轉(zhuǎn)換成其他格式的方法。

　　P5EE有哪些版本

　　分別使用模塊，web程序，命令行程序樣本文件中版本的代碼。模塊中的$VERSION將會(huì)反映出CVS的版本。Makefile.PL文件應(yīng)該包含版本描述，并且還應(yīng)該不依賴于CVS倉(cāng)庫(kù)中任何一個(gè)單獨(dú)文件的版本。同樣，擁有$VERSION的XS模塊也會(huì)反映出發(fā)行版的版本，否則每當(dāng)你對(duì)文件做了一點(diǎn)改動(dòng)，你都需要重新編譯那些已經(jīng)共享的庫(kù)。這對(duì)于從事開發(fā)工作中的人來(lái)講，的確是一種痛苦。我們的發(fā)行版本號(hào)使用tuples模式，第一個(gè)數(shù)字是主修訂號(hào)，第二個(gè)數(shù)字是版本號(hào)，第三個(gè)數(shù)字是子版本號(hào)。Odd-numbered版本號(hào)是開發(fā)版本。

感謝各位的閱讀，以上就是“P5EE的編碼規(guī)則有哪些”的內(nèi)容了，經(jīng)過本文的學(xué)習(xí)后，相信大家對(duì)P5EE的編碼規(guī)則有哪些這一問題有了更深刻的體會(huì)，具體使用情況還需要大家實(shí)踐驗(yàn)證。這里是億速云，小編將為大家推送更多相關(guān)知識(shí)點(diǎn)的文章，歡迎關(guān)注！