PHP文件注釋標(biāo)記及規(guī)范小結(jié)
Jun 13, 2016 pm 12:01 PM
PHP 注釋標(biāo)記
@access
使用范圍：class,function,var,define,module
該標(biāo)記用于指明關(guān)鍵字的存取權(quán)限：private、public或proteced
@author
指明作者
@copyright
使用范圍：class，function，var，define，module，use
指明版權(quán)信息
@deprecated
使用范圍：class，function，var，define，module，constent，global，include
指明不用或者廢棄的關(guān)鍵字
@example
該標(biāo)記用于解析一段文件內(nèi)容，并將他們高亮顯示。Phpdoc會試圖從該標(biāo)記給的文件路徑中讀取文件內(nèi)容
@const
使用范圍：define
用來指明php中define的常量
@final
使用范圍：class,function,var
指明關(guān)鍵字是一個最終的類、方法、屬性，禁止派生、修改。
@filesource
和example類似，只不過該標(biāo)記將直接讀取當(dāng)前解析的php文件的內(nèi)容并顯示。
@global
指明在此函數(shù)中引用的全局變量
@ingore
用于在文檔中忽略指定的關(guān)鍵字
@license
相當(dāng)于html標(biāo)簽中的,首先是URL，接著是要顯示的內(nèi)容
例如百度
可以寫作 @license http://www.baidu.com 百度
@link
類似于license
但還可以通過link指到文檔中的任何一個關(guān)鍵字
@name
為關(guān)鍵字指定一個別名。
@package
使用范圍：頁面級別的-> define，function，include
類級別的->class，var，methods
用于邏輯上將一個或幾個關(guān)鍵字分到一組。
@abstrcut
說明當(dāng)前類是一個抽象類
@param
指明一個函數(shù)的參數(shù)
@return
指明一個方法或函數(shù)的返回指
@static
指明關(guān)建字是靜態(tài)的。
@var
指明變量類型
@version
指明版本信息
@todo
指明應(yīng)該改進或沒有實現(xiàn)的地方
@throws
指明此函數(shù)可能拋出的錯誤異常,極其發(fā)生的情況
普通的文檔標(biāo)記標(biāo)記必須在每行的開頭以@標(biāo)記，除此之外，還有一種標(biāo)記叫做inline tag,用{@}表示，具體包括以下幾種：
{@link}
用法同@link
{@source}
顯示一段函數(shù)或方法的內(nèi)容
注釋規(guī)范
a.注釋必須是
/**
* 注釋內(nèi)容
*/
的形式
b.對于引用了全局變量的函數(shù)，必須使用glboal標(biāo)記。
c.對于變量，必須用var標(biāo)記其類型（int,string,bool…）
d.函數(shù)必須通過param和return標(biāo)記指明其參數(shù)和返回值
e.對于出現(xiàn)兩次或兩次以上的關(guān)鍵字，要通過ingore忽略掉多余的，只保留一個即可
f.調(diào)用了其他函數(shù)或類的地方，要使用link或其他標(biāo)記鏈接到相應(yīng)的部分，便于文檔的閱讀。
g.必要的地方使用非文檔性注釋，提高代碼易讀性。
h.描述性內(nèi)容盡量簡明扼要，盡可能使用短語而非句子。
i.全局變量，靜態(tài)變量和常量必須用相應(yīng)標(biāo)記說明
熱AI工具
Undress AI Tool
免費脫衣圖片
Undresser.AI Undress
人工智慧驅(qū)動的應(yīng)用程序，用於創(chuàng)建逼真的裸體照片
AI Clothes Remover
用於從照片中去除衣服的線上人工智慧工具。
Clothoff.io
AI脫衣器
Video Face Swap
使用我們完全免費的人工智慧換臉工具，輕鬆在任何影片中換臉！
熱門文章
熱工具
記事本++7.3.1
好用且免費的程式碼編輯器
SublimeText3漢化版
中文版，非常好用
禪工作室 13.0.1
強大的PHP整合開發(fā)環(huán)境
Dreamweaver CS6
視覺化網(wǎng)頁開發(fā)工具
SublimeText3 Mac版
神級程式碼編輯軟體(SublimeText3)
熱門話題
為什麼我們評論：PHP指南
Jul 15, 2025 am 02:48 AM
PHPhasthreecommentstyles://,#forsingle-lineand/.../formulti-line.Usecommentstoexplainwhycodeexists,notwhatitdoes.MarkTODO/FIXMEitemsanddisablecodetemporarilyduringdebugging.Avoidover-commentingsimplelogic.Writeconcise,grammaticallycorrectcommentsandu
如何在Windows上安裝PHP
Jul 15, 2025 am 02:46 AM
安裝PHP在Windows上的關(guān)鍵步驟包括：1.下載合適的PHP版本並解壓，推薦使用ThreadSafe版本配合Apache或NonThreadSafe版本配合Nginx；2.配置php.ini文件，將php.ini-development或php.ini-production重命名為php.ini；3.將PHP路徑添加到系統(tǒng)環(huán)境變量Path中以便命令行使用；4.測試PHP是否安裝成功，通過命令行執(zhí)行php-v和運行內(nèi)置服務(wù)器測試解析能力；5.若使用Apache，需在httpd.conf中配置P
您的第一個PHP腳本：實用介紹
Jul 16, 2025 am 03:42 AM
如何開始編寫第一個PHP腳本？首先設(shè)置本地開發(fā)環(huán)境，安裝XAMPP/MAMP/LAMP，使用文本編輯器，了解服務(wù)器運行原理。其次，創(chuàng)建一個名為hello.php的文件，輸入基本代碼並運行測試。第三，學(xué)習(xí)混合使用PHP與HTML以實現(xiàn)動態(tài)內(nèi)容輸出。最後，注意常見錯誤如缺少分號、引用問題及文件擴展名錯誤，並開啟錯誤報告以便調(diào)試。
什麼是PHP，它是用什麼？
Jul 16, 2025 am 03:45 AM
PHPisaserver-sidescriptinglanguageusedforwebdevelopment,especiallyfordynamicwebsitesandCMSplatformslikeWordPress.Itrunsontheserver,processesdata,interactswithdatabases,andsendsHTMLtobrowsers.Commonusesincludeuserauthentication,e-commerceplatforms,for
您如何處理PHP中的文件操作（閱讀/寫作）？
Jul 16, 2025 am 03:48 AM
tohandlefileoperationsinphp，useApprepreprunctions andModes.1.toreadafile，usefile_get_contents（）forsmallfilesorfgets（）inaloopforline by line-line-processing.2.towriteToafile，usefile_put_cte_contents（usefile_contents）（
PHP語法：基礎(chǔ)知識
Jul 15, 2025 am 02:46 AM
PHP的基礎(chǔ)語法包括四個關(guān)鍵點：1.PHP標(biāo)籤必須使用結(jié)束，推薦使用完整標(biāo)籤；2.輸出內(nèi)容常用echo和print，其中echo支持多參數(shù)且效率更高；3.註釋方式有//、#和//，用於提升代碼可讀性；4.每條語句必須以分號結(jié)尾，空格和換行不影響執(zhí)行但影響可讀性。掌握這些基本規(guī)則有助於寫出清晰穩(wěn)定的PHP代碼。
PHP 8安裝指南
Jul 16, 2025 am 03:41 AM
在Ubuntu上安裝PHP8的步驟為：1.更新軟件包列表；2.安裝PHP8及基礎(chǔ)組件；3.檢查版本確認(rèn)安裝成功；4.按需安裝額外模塊。 Windows用戶可下載ZIP包並解壓，隨後修改配置文件、啟用擴展並將路徑加入環(huán)境變量。 macOS用戶推薦使用Homebrew安裝，依次執(zhí)行添加tap、安裝PHP8、設(shè)置默認(rèn)版本及驗證版本等步驟。不同系統(tǒng)下安裝方式雖有差異，但流程清晰，根據(jù)用途選對方法即可。
python如果還有示例
Jul 15, 2025 am 02:55 AM
寫Python的ifelse語句關(guān)鍵在於理解邏輯結(jié)構(gòu)與細(xì)節(jié)。 1.基礎(chǔ)結(jié)構(gòu)是if條件成立執(zhí)行一段代碼，否則執(zhí)行else部分，else可選；2.多條件判斷用elif實現(xiàn)，順序執(zhí)行且一旦滿足即停止；3.嵌套if用於進一步細(xì)分判斷，建議不超過兩層；4.簡潔場景可用三元表達(dá)式替代簡單ifelse。注意縮進、條件順序及邏輯完整性，才能寫出清晰穩(wěn)定的判斷代碼。
